js-utils/README.md

37 lines
1.1 KiB
Markdown
Raw Normal View History

2022-05-04 02:25:36 +03:00
# js-utils
2023-03-29 18:48:23 +03:00
## Introduction
js-utils is a collection of utilities that facilitate software development in a javascript environment.
## Package installation
2022-05-04 02:25:36 +03:00
```bash
// with npm
2022-12-28 18:10:44 +02:00
npm i --save @flare/js-utils --registry https://lab.code-rove.com/public-node-registry
2022-05-04 02:25:36 +03:00
// with yarn
2022-12-28 18:10:44 +02:00
yarn add @flare/js-utils --registry https://lab.code-rove.com/public-node-registry
2022-05-04 02:25:36 +03:00
```
## How to use the package
2022-05-04 02:25:36 +03:00
```jsx
2023-03-29 18:48:23 +03:00
import { typeValidator, localStorage, camelizeKeys } from "@flare/js-utils";
2022-05-04 02:25:36 +03:00
```
## 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`.
2023-03-29 18:48:23 +03:00
## Changelog
1.0.0 - This version includes data type validators and local storage utils
2023-03-29 19:07:20 +03:00
1.0.1 - Set new domain in configs
2023-03-29 19:08:06 +03:00
1.0.2 - Utility functions export fix
2023-03-29 19:07:20 +03:00
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.