Skip to content

Latest commit

 

History

History
184 lines (114 loc) · 6.25 KB

readme.md

File metadata and controls

184 lines (114 loc) · 6.25 KB
Raw

A number object that is safe to use for financial numbers. Won't ever convert your numbers to floating point!

JS engine support

Starting with version 2, financial-number uses native BigInt, which is supported in node 10.8+ and modern browsers.

Premise

If you're doing math on financial numbers - invoice items, tax rates, those sorts of things - you can't ever afford to represent your numbers with floating point numbers.

Store them as exact/fixed-point types in the database, and in JavaScript, pass them around as strings to avoid losing data.

Precision

The precision (the number of significant digits after the decimal point) of an operation's result is based on the precision of its inputs.

With multiplication, the number of digits after the decimal point is the sum of the precision of both operands, e.g. 12.00 * 5.0 is 60.000.

Addition and subtraction always result in the precision of the highest-precision of the operands: 12.00 + 5 is 17.00.

Why does this matter?

Imagine you are calculating the subtotal, tax, and total for an invoice.

The customer is purchasing 1.5 sheets of plywood at 24.99$ per unit.

The tax rate is 14%.

Calculating it out: the subtotal is 37.485, tax to collect is 5.2479, and the invoice total is 42.7329.

Now, you can't actually charge your customers in increments less than .01$, and customers aren't used to seeing fractional cents on their invoices. so you trim all the numbers to two places after the decimal on their receipt: subtotal of 37.48, tax of 5.24, total 42.73.

...except now the customers will be even more confused, because the subotal and the tax add up to a different number than the total (42.72).

(Note that the numbers still add up wrong even if you round the numbers to the nearest cent rather than trimming! Subtotal 37.49 + tax 5.25 = 42.74)

How to fix it

You can either continue calculating subtotal/tax/total like this and explain the business logic to your customers every time they ask you why the numbers don't add up, or you can round your numbers to two decimal places before you add them together.

(This may not actually be okay! Ask your accountant.)

const subtotal = number('1.5').times('24.99')
const rounded_subtotal = subtotal.changePrecision(2)
rounded_subtotal.toString() // => '37.48'

const tax = rounded_subtotal.times('0.14')
const rounded_tax = tax.changePrecision(2)
rounded_tax.toString() // => '5.24'

const total = rounded_subtotal.plus(rounded_tax)
total.toString() // => '42.72'

Precision general principle

Whenever you need to display or store a number with a specific number of digits after the decimal place, you should explicity set that number to the correct precision before using it in any further calculations.

Rounding methods

When changing the precision of a number, you can choose how you want the number rounded.

By default, numbers will be trimmed - number('114.9885').toString(2) will return 114.98.

If you prefer rounding, you can pass in the provided rounding strategy: number('114.9885').toString(2, number.round) will produce 114.99.

Which one should you use?

In general, the IRS probably won't care which method you use as long as you use it everywhere consistently. In practice, ask your accountant.

If your accountant tells you you need some other rounding strategy, you can bring your own. Rounding functions take two arguments: a financial-number object, and a number representing the desired number of digits after the decimal point. They should return a string.

Usage

npm install financial-number
const number = require('financial-number')
number('11.0').minus('9').times('3.75').toString() // => '7.500'
number('99.99').times('1.15').gt('100') // => true

Default to your preferred rounding strategy

So that if you want a different default (besides the default default trim), you don't have to pass in your chosen strategy every time you call toString or changePrecision.

const { round, withDefaultRoundingStrategy } = require('financial-number')

const number = withDefaultRoundingStrategy(round)

module.exports = number

API

  • number(string)
const numberValue = number('50.0')

Pass in the string representation of a number, get back a financial number object.

Financial numbers are immutable, and functions return a new number object.

Financial number objects have these methods. The operations and comparisons all take strings, or financial number objects.

Operations

  • numberValue.plus(num)
  • numberValue.minus(num)
  • numberValue.times(num)
  • numberValue.mod(num)

Comparisons

They return true or false.

  • numberValue.gt(num)
  • numberValue.gte(num)
  • numberValue.lt(num)
  • numberValue.lte(num)
  • numberValue.equal(num)

Other utility methods

numberValue.changePrecision(newPrecision, [roundingStrategy])

Takes a new precision, and an optional rounding strategy. Returns a new number object. See Rounding methods

number('14.556').changePrecision(2, number.trim).toString() // => '14.55'

numberValue.toString([displayPrecision, [roundingStrategy]])

Returns a string representation of the number for display or storage. You can specify the precision and rounding strategy to be passed to changePrecision if you like - by default, the number will display at its current precision. See Rounding methods

number('99.99').toString() // => '99.99'

numberValue.getPrecision()

number('99.99').getPrecision() // => 2

numberValue.isNegative()

number('13').isNegative() // => false
number('13').times('-1').isNegative() // => true

Running the tests/contributing

git clone https://github.com/TehShrike/financial-number.git
cd financial-number
npm install
npm test

Other

I never use this, so you don't have to mess around with bind to do whatever wacky functional things you want, like this:

const halved = ['10', '13', '50'].map(number('0.5').times)

Licensed WTFPL