@zibuthe7j11/adipisci-repudiandae-quasi
Version:
A collection of strongly typed JS utilities.
26 lines (19 loc) • 1.22 kB
Markdown
# /adipisci-repudiandae-quasi
A collection of strongly typed JS utilities.
## Installation
Using npm:
```shell
$ npm i --save /adipisci-repudiandae-quasi
```
## Configuration
The global variable `DEBUG_MODE` must be set for js-util to function correctly. Setting `DEBUG_MODE`
to true enables debug assertions. In production builds it is recommended to use a tool such as uglify-js' dead code
removal to strip out all of these checks.
For a full list of debug flags, see `IStandardDebugFlags` in the API reference.
## Usage
Utility functions are provided as both stand alone and grouped by category, e.g. `_Array.compactMap` and `arrayCompactMap` are the same.
A collection of standard debug utilities such as assert is provided in `_Debug`. More specialized cases are exported separately, these are prefixed with `Debug`.
All debug checks should be hidden behind a `DEBUG_MODE` predicate.
Where an assertion is required in production code these should make use of `_Production`.
## Documentation
See [API reference](https://phuhgh.github.io/js-util/@zibuthe7j11/adipisci-repudiandae-quasi.html) for the latest API docs, for previous versions consult the documentation bundled in the package.