# @anip/formula

> Formula package

Latest version **6.0.0** (published 2023-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @anip/formula
pnpm add @anip/formula
yarn add @anip/formula
bun add @anip/formula
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2023-04-04 |
| First published | 2023-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 219.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | john3200 |

## Links

- npm: https://www.npmjs.com/package/@anip/formula
- npm.io page: https://npm.io/package/@anip/formula

## Dependencies (1)

- [@formatjs/intl-numberformat](https://npm.io/package/@formatjs/intl-numberformat.md) ^8.3.5

## Recent versions

- 6.0.0 (latest) — 2023-04-04
- 5.0.0 — 2023-04-04
- 4.0.0 — 2023-04-04
- 3.0.0 — 2023-04-04
- 2.0.0 — 2023-04-04
- 1.1.1 — 2023-02-01
- 1.1.0 — 2023-02-01

## README

# Formula


## Installation

npm:
```
$ npm install --save @anip/formula
```

yarn:
```
$ yarn add @anip/formula
```

## Usage
Once the package is installed, you can import the library using `import` or `require` approach:

```
import formula from '@anip/formula`;

console.log(formula.version);

// or

import { version } from '@anip/formula`;

console.log(version);

// or

const formula = require('@anip/formula);

console.log(formula.version);
```

## APIs
| Function/Scoped Function        | Docs                                                                                                       |
|---------------------------------|------------------------------------------------------------------------------------------------------------|
| `fv`                            | [README](https://gitlab.com/pinaid/npm-goal-package/-/blob/purba/packages/formula/src/fv/README.md)        |
| `pv`                            | [README](https://gitlab.com/pinaid/npm-goal-package/-/blob/purba/packages/formula/src/pv/README.md)        |
| `pmt`                           | [README](https://gitlab.com/pinaid/npm-goal-package/-/blob/purba/packages/formula/src/pmt/README.md)       |
| `compound`                      | [README](https://gitlab.com/pinaid/npm-goal-package/-/blob/purba/packages/formula/src/compound/README.md)  |
| `goal` (scoped)                 | [README](https://gitlab.com/pinaid/npm-goal-package/-/blob/purba/packages/formula/src/goal/README.md)      |


## Test & Development
From root project:
```
$ npm run test:watch --workspace=@anip/formula
```

From formula directory:
```
$ npm run test:watch
```

## Run Examples
Run the package as dev & watch mode:
```
$ npm run dev --workspace=@anip/formula
```

Run the examples:
```
$ cd packages/formula/examples
$ npm start
```

## Build
From root project:
```
$ npm run build --workspace=@anip/formula
```

## Versioning & Add Changelogs

### Create changelog draft:
```
$ npm run changeset
```

Update draft inside `.changeset/newly-added-draft-file-name.md`

### 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=@anip/formula
```

---
_Source: https://npm.io/package/@anip/formula · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._