math-toolbox

Lightweight and modular collection of JS math functions

Documentation

Full documentation and list of available modules:

https://terkelg.github.io/math-toolbox/

---

Install

Node

Install math-toolbox from NPM

$ npm install math-toolbox --save

Usage

You can import individual modules

import { clamp, map } from 'math-toolbox'

or the entire package

import * as MT from 'math-toolbox'

Browser

To use in browser, grab the math-toolbox.umd.min.js file and add it to your page, or use the CDN:

https://unpkg.com/math-toolbox/dist/math-toolbox.umd.min.js

Plans

See GitHub Wiki: https://github.com/terkelg/math-toolbox/wiki

Build

First clone the project from github:

git clone git://github.com/terkelg/math-toolbox.git
cd math-toolbox

Install the project dependencies:

$ npm install

Then, the project can be build by executing the build script via NPM:

$ npm run build

Build and uglify with:

$ npm run build:uglify

Test

Jest is used for unit testing. Test with:

$ npm test

To watch for changes and test use:

$ npm test:watch

Get code coverage with

$ npm test:coverage

License

MIT @ Terkel Gjervig