153 lines
5.5 KiB
Markdown
153 lines
5.5 KiB
Markdown
# JS Utils
|
|
|
|
This project is a collection of utilities, 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 has no dependencies.
|
|
|
|
## Features
|
|
|
|
[Please see the complete API docs](https://github.com/ssube/js-utils/blob/master/docs/api/js-utils.md) for the full
|
|
function list.
|
|
|
|
Features utilities and helpers for:
|
|
|
|
- Array
|
|
- assertions/guards:
|
|
- `hasItems`
|
|
- `isArray` for both `Array`/`ReadonlyArray`
|
|
- `isEmpty`
|
|
- `lengthOf`
|
|
- conversion
|
|
- `filterZip`
|
|
- `toArray`
|
|
- Array Mapper
|
|
- array-to-map converter, reduces an array of values to a map, using an array of keys
|
|
- Async
|
|
- timed promises
|
|
- `defer`/`deferValue`
|
|
- `deferUntil`
|
|
- `timeout`
|
|
- Buffer
|
|
- concatenation
|
|
- `concat`
|
|
- `encode`
|
|
- Checklist
|
|
- allow/deny list
|
|
- Child Process
|
|
- `childResult`
|
|
- `writeInput`
|
|
- Env Vars
|
|
- `isDebug`
|
|
- Errors
|
|
- nestable, typed error
|
|
- `ChildProcessError`
|
|
- `InvalidArgumentError`
|
|
- `MissingKeyError`
|
|
- `NotFoundError`
|
|
- `NotImplementedError`
|
|
- `TimeoutError`
|
|
- Logger
|
|
- test logging helpers
|
|
- Map
|
|
- types
|
|
- `MapLike`
|
|
- assertions/guards:
|
|
- `mustGet`
|
|
- null-safe helpers
|
|
- `getOrDefault`
|
|
- helpers for `Map<K, Array<V>>`
|
|
- `getHead`/`getHeadOrDefault`
|
|
- `setOrPush`
|
|
- concat/merge
|
|
- `mergeMap`
|
|
- `pushMergeMap`
|
|
- conversion
|
|
- `entriesOf`
|
|
- `makeDict`
|
|
- `makeMap`
|
|
- `pairsToMap`
|
|
- Math
|
|
- predicates for functional methods
|
|
- `sum`
|
|
- Maybe
|
|
- types
|
|
- `Maybe`
|
|
- `None`
|
|
- assertions/guards
|
|
- `doesExist`
|
|
- `mustExist`
|
|
- `mustDefault`
|
|
- `mustFind`
|
|
- `removeNone`
|
|
- null-safe helpers
|
|
- `isNone`
|
|
- `isSome`
|
|
- Predicate
|
|
- types for functional methods
|
|
- Reflect
|
|
- `getConstructor`
|
|
- `getMethods`
|
|
- Signal
|
|
- wait for OS signal
|
|
- `signal`
|
|
- String
|
|
- `leftPad`
|
|
- `trim` with suffix
|