README.md

JSLib

A collection of functional utility libraries for TS/JS projects!

WARNING: This library is only used in my own projects, but PRs, reporting issues and suggestions are welcome!

Installation

To install the latest version:

$ npm install --save-dev zhenwenc/jslib

Most likely you'll also need the Immutable.js library.

$ npm install --save-dev immutable

Documentation

Read the docs and taste the FP candies!

Contributing

If you'd like to contribute to JSLib, you'll need to run the following commands to get your environment set up:

$ git clone https://github.com/zhenwenc/jslib.git
$ cd jslib                  # go to the jslib directory
$ npm install               # install local npm build / test dependencies

# Available scripts:

$ npm run build             # compile typescript source code
$ npm run test              # run all unit test suits
$ npm run watch:test        # watch for source / test file changes
$ npm run docs              # generate documentation files

npm run watch:test will watch for changes in the /src/ and /test/ directory, compile the source files when a change occurs. The output files are written to the /dist/ directory. It will also re-run the unit tests every time you update any source files.

License

JSLib is MIT-licensed.