Approximate Number

Abbreviates numbers into a more human-friendly format, similar to ls's --human-readable flag (ls -lh) or Stack Overflow's reputation numbers. For example, 123456 becomes '123k'.

Works in Node.js and in browsers.

1var approx = require('approximate-number');
2
3console.log(approx(1234));
4//> 1.2k
5
6console.log(approx(12345));
7//> 12k
8
9console.log(approx(1234, {decimal: false}));
10//> 1k
11
12console.log(approx(1234, {decimal: ','}));
13//> 1,2k
14
15console.log('My Stack Overflow reputation is %s.', approx(3671, {
16  min10k: true
17}));
18//> My Stack Overflow reputation is 3,671.
19
20console.log('The US national debt is %s.', approx(19939034457936, {
21  prefix: '$', 
22  capital: true, 
23  round: true
24}));
25// > The US national debt is $20T.
26
27// Truncates/floors numbers by default
28approx(9999);
29// > '9.9k'
30
31// Set `round: true` to round instead of floor.
32approx(9999,{round: true});
33// > '10k'
34

Getting Started

Node.js

Install node module with: npm install --save approximate-number

1var approx = require('approximate-number');
2approx(123456) // 123k

Bower

Install with: bower install approximate-number

1<script src="/bower_components/approximate-number/lib/approximate-number.js"></script>
2<script>
3alert(approximateNumber(1234567890)); // 1.2b
4</script>

Browser usage without a package manager

Grab the latest approximate-number.js and copy it onto your site.

Options

• separator {String|Boolean} Default = ','. Thousands separator - set to a string (e.g. '.') to use that string or false to not use any separator.
• decimal {String|Boolean} Default = '.'. Decimal - set to a string (e.g. ',') to use that or set to false to avoid outputting values with a decimal.
• round {Boolean} Default = false. Round numbers off rather than flooring/truncating. When true, 105000 would become '11m', when false it becomes '10m'.
• min10k {Boolean} Default = false. Do not abbreviate numbers below 10000. E.g. 9999 would become '9,999' rather than '9k'. (Stack Overflow-style).
• prefix {String} Default = ''. Optional string to prepend to the value, e.g. '$'.
• suffix {String} Default = ''. Optional string to append to the value, e.g. '%'.
• capital {Boolean} Default = false. Set to true to use capital letters, e.g. 3.9M instead of 3.9m
• precision {Number} Default = undefined. Number of significant digits. Must be greater than 0. Use of this option forces rounding.

V2.1 Changes

• Added precision

V2 Changes

• Added optional configuration object
• Changed default from rounding to truncation. Override with options.round=true.
• Started abbreviating numbers between 1000 and 9999 by default. Override with options.min10k=true.
• Added trillions support.
• Dropped cli support.

License

Copyright (c) 2014 Nathan Friedly
Licensed under the MIT license.