tolars.js

Tolar utilities in JavaScript (and TypeScript).

Features

• Tiny
• Extensive documentation
• Large collection of test cases which are maintained and added to
• Apache 2 License; completely open source to do with as you please

Installing

To use in node.js:

/> npm install --save tolars

Documentation

Usage

Import the library in your code:

const tolars = require('tolars');
// or ES6 style
import tolars from 'tolars';

API

// TODO: Document API methods

Commands

• npm run clean - Remove lib/ directory
• npm test - Run tests with linting and coverage results.
• npm test:only - Run tests without linting or coverage.
• npm test:watch - You can even re-run tests on file changes!
• npm test:prod - Run tests with minified code.
• npm run test:examples - Test written examples on pure JS for better understanding module usage.
• npm run lint - Run ESlint with airbnb-config
• npm run lint:fix - Run ESlint with airbnb-config and fix issues
• npm run coverage - Get coverage report for your code.
• npm run build - Babel will transpile ES6 => ES5 and minify the code.
• npm run prepublish - Hook for npm. Do all the checks before publishing your module.

Library development features

• ES6/ESNext - Write ES6 code and Babel will transpile it to ES5 for backwards compatibility
• Test - Mocha with Istanbul coverage
• Lint - Preconfigured ESlint with Airbnb config
• CI - CircleCI configuration setup
• Minify - Built code will be minified for performance

License

This project is open source and distributed under the Apache License Version 2.0 license.