Math Money

Math money is a module aimed for safe currency manipulation, by not operating with pure floating points.

Installation

1    npm install math-money

Quickstart

1    var Money = require('math-money');
2
3    var oneDollar = Money.Dollar(1); //create using an integer
4    var oneEuro = Money.Euro('12.00'); //create using a string
5
6    var result = Money.Dollar(12).plus( Money.Dollar('10.00') );
7    console.log( result.format() ); // US$ 22.00

Defining Your Currency

1    var Money = require('math-money');
2    var MyCurrency = Money.factory('MyCurrency', {
3        decimals: 2,
4        prefix: 'My$'
5    });
6
7    console.log( MyCurrency(10).format() ); //My$ 10.00

To create a custom currency, use Money.factory method. It accepts the currency identifier as first parameter and a config object as second, with the following fields:

• decimals (how many decimal places the currency supports)
• prefix (the prefix to format the currency. Normally you should put the currency symbol)

Operations

Money objects are immutable, so all math operations will not modify the object itself, but return another one.

• Plus

Money.Dollar(1).plus( Money.Dollar(2) )
Should return a Money.Dollar(3);

• Minus

Money.Dollar(2).minus( Money.Dollar(1) )
Should return a Money.Dollar(1)

• isMoreThan

Money.Dollar(2).isMoreThan( Money.Dollar(1) )
Should return a true if money value is bigger that the compared one

• isLessThan

Money.Dollar(1).isLessThan( Money.Dollar(2) )
Should return a true if money value is lower that the compared one

• equals

Money.Dollar(1).equals( Money.Dollar(1) )
Should return a true if money value and the compared one are equal

Different currencies cannot interoperate. If you try to add, subtract or compare different currencies, an exception will be thrown.

Convenience Methods

• Currency.raw

1    var Money = require('math-money');
2    Money.Dollar.raw( 2000 ); // US$ 20.00
3    Money.Yen.raw(2000); // ¥ 2000

This generates a Money object built with a raw integer value. This value will then be converted to decimal if needed.

• Currency.ZERO

1    var Money = require('math-money');
2    Money.Dollar.ZERO; // US$ 0.00
3    Money.BRL.ZERO; // R$ 0.00
4    Money.Yen.ZERO; // ¥ 0

Returns a money value representing no money.

Built in currencies

math-currency currently supports these currencies out of the box:

• Brazilian Real Money.BRL
• Euro Money.Euro or Money.EUR
• Japanese Yen Money.Yen or Money.JPY
• US Dollar Money.Dollar or Money.USD)