@bamburobo/calculators v0.2.0

@bamburobo/calculators

This is the library to do

Features

• Typescript with documentation and autocomplete function

Installing

Using npm:

npm install --save @bamburobo/calculators

Please make sure you have an access to our npm as this is a private repository

Getting Started

To import the modules, refer to the following

Commonjs

const calculators = require('@bamburobo/calculators');
const timeWeightedReturn = calculators.timeWeightedReturn;

ES6 or Typescript

import { timeWeightedReturn } from '@bamburobo/calculators';

For usage, please check the test files under ./test

Generating Docs

1. npm run docs to generate documentation
2. go to ./docs/index.html and open it in your browser

Documentation uses Typedoc to generate. Please let us know if you have any questions with the documentation

Running tests

npm run test to run tests. Tests use Karma, and runs on Phantomjs

npm run test:watch runs the tests on watch mode, and refreshes on file changes

Build JS Files

npm run build

The output of the build would be at ./dist, it will follow the structure from the ./src folder.

Output JS files are in ES5 so there might be a need to transpile these files.

Rationale

Separating the core calculator logic from the implementation makes the management of the infrastructure make more sense

Built With

• Typescript - typed superset of javascript
• Typedoc - documentation generator

Authors

• Paul Sherwin Ang - Initial work - sherwin@bambu.life