Options
All
  • Public
  • Public/Protected
  • All
Menu

@behaveware/nucleus

Nucleus

A collection of essential utilities designed to be the central and most important part of any Typescript Developer's toolkit.

License: MIT

Test Coverage

Branches Functions Lines Statements
badge-branches badge-functions badge-lines badge-statements

Getting Started

Install

npm install --save @behaveware/nucleus

Documentation

Documentation is currently inside the code and is exported using TypeDoc and can be found here

# Refresh Documentation and Coverage Badges
npm run refreshdocs

Getting Started for Contributors

Pull down repository:

git clone https://github.com/BehaveWare/nucleus.git

Run all unit tests (JEST):

npm test

Run all tests with coverage:

npm run test:coverage

Run linter (TSLint):

npm run lint

Run formatter (Prettier):

npm run format

Generated using TypeDoc