118 lines
5.0 KiB
Markdown
118 lines
5.0 KiB
Markdown
# JS Utils
|
|
|
|
This project is a collection of utilities meant to extend lodash, collected from my
|
|
other Typescript projects, lightly documented, and heavily tested.
|
|
|
|
## Contents
|
|
|
|
- [JS Utils](#js-utils)
|
|
- [Contents](#contents)
|
|
- [Status](#status)
|
|
- [Releases](#releases)
|
|
- [Usage](#usage)
|
|
- [Features](#features)
|
|
|
|
## Status
|
|
|
|
[](https://git.apextoaster.com/ssube/js-utils/commits/master)
|
|
[](https://sonarcloud.io/dashboard?id=ssube_js-utils)
|
|
[](https://codecov.io/gh/ssube/js-utils)
|
|
[](https://github.com/ssube/js-utils/blob/master/LICENSE.md)
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fssube%2Fjs-utils?ref=badge_shield)
|
|
|
|
[](https://github.com/ssube/js-utils/issues?q=is%3Aopen+is%3Aissue+label%3Atype%2Fbug)
|
|
[](https://github.com/ssube/js-utils/issues?q=is%3Aopen+is%3Aissue)
|
|
[](https://github.com/ssube/js-utils/issues?q=is%3Aissue+is%3Aclosed)
|
|
|
|
[](https://renovatebot.com)
|
|
[](https://david-dm.org/ssube/js-utils)
|
|
[](https://david-dm.org/ssube/js-utils?type=dev)
|
|
[](https://snyk.io/test/github/ssube/js-utils)
|
|
|
|
[](https://codeclimate.com/github/ssube/js-utils/maintainability)
|
|
[](https://codeclimate.com/github/ssube/js-utils/trends/technical_debt)
|
|
[](https://codeclimate.com/github/ssube/js-utils/issues)
|
|
[](https://lgtm.com/projects/g/ssube/js-utils/context:javascript)
|
|
[](https://lgtm.com/projects/g/ssube/js-utils/alerts/)
|
|
|
|
## Releases
|
|
|
|
[](https://github.com/ssube/js-utils/releases)
|
|
[](https://github.com/ssube/js-utils/releases)
|
|
[](https://github.com/ssube/js-utils/compare/v0.1.6...master)
|
|
|
|
[](https://www.npmjs.com/package/@apextoaster/js-utils)
|
|
[](https://www.npmjs.com/package/@apextoaster/js-utils)
|
|
[](https://www.npmjs.com/package/@apextoaster/js-utils)
|
|
|
|
## Usage
|
|
|
|
Install:
|
|
|
|
```shell
|
|
yarn add -D @apextoaster/js-utils
|
|
```
|
|
|
|
And import:
|
|
|
|
```typescript
|
|
import { mustExist } from '@apextoaster/js-utils';
|
|
```
|
|
|
|
The library is bundled and depends on lodash, linked in a vendor module.
|
|
|
|
## Features
|
|
|
|
- array mapper
|
|
- map elements to keys by order
|
|
- skip initial, gather remaining
|
|
- async
|
|
- defer
|
|
- promise timeout
|
|
- wait for predicate
|
|
- async tracker
|
|
- track and log leaking async resources for tests
|
|
- buffer
|
|
- checklist
|
|
- include/exclude mode (whitelist/blacklist)
|
|
- child process
|
|
- wait for exit and gather output
|
|
- write and flush
|
|
- env
|
|
- check `DEBUG`
|
|
- list
|
|
- concat lists
|
|
- logger
|
|
- get test logger (null or console depending on `DEBUG`)
|
|
- map
|
|
- must get (assertion)
|
|
- get or default
|
|
- get head from list value
|
|
- get head or default
|
|
- set or push to key
|
|
- merge maps
|
|
- push-merge maps
|
|
- convert dict to map and vice versa
|
|
- normalize map values to lists
|
|
- create map from name-value pairs
|
|
- maybe
|
|
- is nil test (negative nil test)
|
|
- count array or maybe
|
|
- filter nil from list
|
|
- must find (assertion)
|
|
- does exist (positive nil test)
|
|
- must exist (assertion)
|
|
- must default (assertion)
|
|
- pid file
|
|
- write pid file
|
|
- delete pid file
|
|
- reflect
|
|
- get constructor name
|
|
- get methods from prototype chain
|
|
- signals
|
|
- wait for OS signal
|
|
- string
|
|
- left pad (please don't import just for this)
|
|
- trim with suffix
|
|
|