Helping Hand

Javascript utility library written in typescript.

Documentation Site

Documentation Site

Install

npm i helping_hand

import { module } from 'helping_hand'

Build

Typescript compiler for type declarations. Rollup and babel used for bundling.

Build an output file and type declarations

npm run build

Run types and bunding in watch mode

npm run build:watch

Run only types

npm run build:types

Run type checking

npm run type-check

Local Development

To run locally you will want to npm link the package.

NOTE: If you link then unlink a package you must run your install command again.

* Inside helping_hand
npm link

* Inside Application
npm link helping_hand

Testing

Testing uses Jest and 100% coverage is required.

Run tests

npm run test

Run tests in watch mode

npm run test:watch

Run tests coverage report

npm run test:coverage

Create typedocs

npm run typedoc