ssube

js-utils

Go to file

ssube b91e13fc91 more function signature docs		2021-08-08 15:11:23 -05:00
.github	fix(docs): comment header in PR template	2020-03-02 18:48:34 -06:00
config	fix(build): add docker TLS options, remove codecov job	2021-08-05 22:25:17 -05:00
docs/api	more function signature docs	2021-08-08 15:11:23 -05:00
scripts	feat(build): add alpine image job from salty-dog	2019-11-09 20:17:20 -06:00
src	more function signature docs	2021-08-08 15:11:23 -05:00
test	docs and tests	2021-08-08 14:58:43 -05:00
vendor/rollup-resources	fix: declare resource modules	2019-09-28 10:42:41 -05:00
.codeclimate.yml	feat(build): replace tslint with eslint	2019-11-09 16:50:30 -06:00
.dockerignore	fix(build): add yarn lock to image before installing, add tmp files to docker ignore	2019-09-17 19:05:46 -05:00
.eslintrc.json	feat: full es module build, fix up eslint and sinon imports	2021-07-26 10:12:14 -05:00
.gitignore	feat(reflect): handle missing prototypes	2021-03-27 18:22:36 -05:00
.gitlab-ci.yml	fix(build): add docker TLS options, remove codecov job	2021-08-05 22:25:17 -05:00
.npmignore	fix(build): omit git from package, ignore pid files	2019-11-10 09:47:10 -06:00
.npmrc	feat(config): configure npm to use nexus mirror	2019-09-17 08:18:09 -05:00
CHANGELOG.md	chore(release): 0.4.0	2021-07-27 22:29:54 -05:00
Dockerfile.alpine	update: update node.js to v16	2021-05-28 07:22:22 -05:00
Dockerfile.stretch	update: update node.js to v16	2021-05-28 07:22:22 -05:00
LICENSE.md	feat: copy template from other projects	2019-09-17 07:45:15 -05:00
Makefile	feat: full es module build, fix up eslint and sinon imports	2021-07-26 10:12:14 -05:00
README.md	more function signature docs	2021-08-08 15:11:23 -05:00
package.json	update: update dependency @types/node to v14.17.9	2021-08-04 16:34:40 -05:00
renovate.json	fix: reduce renovate noise, automerge test deps	2021-06-11 10:57:24 -05:00
run.mk	feat: include additional makefiles, add example	2019-09-28 15:24:51 -05:00
tsconfig.json	feat: copy template from other projects	2019-09-17 07:45:15 -05:00
yarn.lock	update: update dependency @types/node to v14.17.9	2021-08-04 16:34:40 -05:00

README.md

JS Utils

This project is a collection of utilities, collected from my other Typescript projects, lightly documented and heavily tested.

JS Utils
- Contents
- Status
- Releases
- Usage
- Features

Status

Releases

Usage

Install:

yarn add -D @apextoaster/js-utils

And import:

import { mustExist } from '@apextoaster/js-utils';

The library is bundled and has no dependencies.

Features

Please see the complete API docs 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