@cowrie/cowrie
v1.1.2
Published
Cowrie is a JavaScript utility that allows you to add, subtract, multiply, divide, sort & partition monetary values
Downloads
9
Readme
Cowrie
Cowrie is a JavaScript utility that allows you to add, subtract, multiply, divide, sort & partition monetary values
Installation
Cowrie requires Node.js v10+ to run.
$ npm install --save @cowrie/cowrie
Usage
Cowrie can be used both in a Node.js environment (server-side) or in a browser environment (client-side). After the installation with npm, add it to your source files using either of the following:
1. ES6 import statement
import Cowrie from "@cowrie/cowrie";
2. Commonjs require statement
const Cowrie = require('@cowrie/cowrie');
The following are methods available in the Cowrie object, which also amount to its features. These are some a few things to note when using the utility.
The results of the
plus()
,minus()
,times()
, anddivide
methods is anotherCowrie
instance. Theallocate()
method however, returns an array ofCowrie
instances. Use the figure property to retrieve a string representation of the monetary value figure, without the currency.
For addition (+) and subtraction (−), the numbers are assumbed to be of the same currency instantiated.
The
allocate()
method takes a array of numbers that represent a ratio, with100%
as a whole.
Features
+ Addition
const a = new Cowrie('KES', 0).plus(2).figure;
const b = new Cowrie('KES', 0).plus(0.1, 0.2).figure;
const c = new Cowrie('KES', 0).plus(...[1.1, 1.1, 1.1, 4]).figure;
console.log({a, b, c});
− Subtraction
const a = new Cowrie('KES', 0).minus(2).figure;
const b = new Cowrie('KES', 0).minus(0.1, 0.2).figure;
const c = new Cowrie('KES', 0).minus(...[1.1, 1.1, 1.1, 4]).figure;
console.log({a, b, c});
× Multiplication
const a = new Cowrie('KES', 2090.5).times(8.61).figure;
const b = new Cowrie('KES', 2090.5, 3).times(8.61).figure;
const c = new Cowrie('KES', 209050).times(8.61).figure;
console.log({a, b, c});
÷ Division
const a = new Cowrie('KES', 1.21).divide(0.1).figure;
const b = new Cowrie('KES', 0.2).divide(0.1).figure;
const c = new Cowrie('KES', 0.2).divide(3).figure;
const d = new Cowrie('KES', 0.3).divide(3).figure;
console.log({a, b, c, d});
a : b : c Allocation
const a = new Cowrie('KES', 500).allocate([3, 2]).map(x => x.figure);
const b = new Cowrie('KES', 500).allocate([1, 1, 1]).map(x => x.figure);
const c = new Cowrie('KES', 500).allocate([0, 1, 1]).map(x => x.figure);
console.log({a, b, c, d});
Comma separators
const a = new Cowrie('KES', 0, 0, true);
const b = new Cowrie('KES', 0.123456, 6,true );
const c = new Cowrie('KES', 100, 0, true );
const d = new Cowrie('KES', 100.123456, 6,true );
const e = new Cowrie('KES', 1000, 0,true );
const f = new Cowrie('KES', 1000.123456, 6, true );
const g = new Cowrie('KES', 10000, 0,true );
const h = new Cowrie('KES', 10000.123456, 6,true );
const i = new Cowrie('KES', 100000, 0,true );
const j = new Cowrie('KES', 100000.123456, 6,true );
const k = new Cowrie('KES', 1000000, 0, true );
const l = new Cowrie('KES', 1000000.123456, 6,true );
const m = new Cowrie('KES', 10000000, 0,true);
const n = new Cowrie('KES', 10000000.123456, 6,true );
console.log({a, b, c, d, e, f, g, h, i, j, k, l, m, n})
License
MIT