37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# js-utils
|
|
|
|
## Introduction
|
|
|
|
js-utils is a collection of utilities that facilitate software development in a javascript environment.
|
|
|
|
## Package installation
|
|
|
|
```bash
|
|
// with npm
|
|
npm i --save @flare/js-utils --registry https://lab.code-rove.com/public-node-registry
|
|
|
|
// with yarn
|
|
yarn add @flare/js-utils --registry https://lab.code-rove.com/public-node-registry
|
|
```
|
|
|
|
## How to use the package
|
|
|
|
```jsx
|
|
import { typeValidator, localStorage, camelizeKeys } from "@flare/js-utils";
|
|
```
|
|
|
|
## Unit testing
|
|
|
|
Unit testing is done using [Jest](https://jestjs.io/). This is an awesome testing framework created by Facebook.
|
|
The files containing tests are identified by the extension `*.test.ts`.
|
|
All tests in the package can be executed by running: `npm test`.
|
|
|
|
## Changelog
|
|
|
|
1.0.0 - This version includes data type validators and local storage utils
|
|
1.0.1 - Set new domain in configs
|
|
1.0.2 - Utility functions export fix
|
|
1.0.3 - Typescript warnings fix
|
|
1.0.4 - Added "camelizeKeys" function
|
|
1.1.0 - The package has been migrated to TypeScript. Unit tests using Jest have also been added.
|