Formula
Installation
npm:
$ npm install --save @pinaid/formula
yarn:
$ yarn add @pinaid/formula
Usage
Once the package is installed, you can import the library using import or require approach:
import formula from '@pinaid/formula`;
console.log(formula.version);
// or
import { version } from '@pinaid/formula`;
console.log(version);
// or
const formula = require('@pinaid/formula);
console.log(formula.version);
APIs
| Function/Scoped Function | Docs |
|---|---|
fv |
README |
pv |
README |
pmt |
README |
compound |
README |
goal (scoped) |
README |
Test & Development
From root project:
$ npm run test:watch --workspace=@pinaid/formula
From formula directory:
$ npm run test:watch
Run Examples
Run the package as dev & watch mode:
$ npm run dev --workspace=@pinaid/formula
Run the examples:
$ cd packages/formula/examples
$ npm start
Build
From root project:
$ npm run build --workspace=@pinaid/formula
Versioning & Add Changelogs
Create changelog draft:
$ npm run changeset
Update draft inside .changeset/newly-added-draft-file-name.json
Bump version & update CHANGELOG.md
$ npm run changeset:version
Publishing
Publish the package to npm:
Need authentication (one time) before publishing to npm, run:
$ npm adduser
Publish:
$ npm publish --workspace=@pinaid/formula