human-format

Converts a number to/from a human readable string: 1337 ↔ 1.34kB

Installation

Node & Browserify/Webpack

Installation of the npm package:

> npm install --save human-format

Then require the package:

1var humanFormat = require("human-format");

Browser

You can directly use the build provided at unpkg.com:

1<script src="https://unpkg.com/human-format@1/index.js"></script>

Usage

Formatting

1humanFormat(1337);
2//=> '1.34 k'
3
4// The maximum number of decimals can be changed.
5humanFormat(1337, {
6  maxDecimals: 1,
7});
8//=> '1.3 k'
9
10// maxDecimals can be set to auto, so that there is 1 decimal between -10 and 10 excluded and none out of this interval.
11humanFormat(1337, {
12  maxDecimals: "auto",
13});
14//=> '1.3 k'
15
16humanFormat(13337, {
17  maxDecimals: "auto",
18});
19//=> '13 k'
20
21// A fixed number of decimals can be set.
22humanFormat(1337, {
23  decimals: 4,
24});
25//=> '1.3370 k'
26
27// Units and scales can be specified.
28humanFormat(65536, {
29  scale: "binary",
30  unit: "B",
31});
32//=> 64 kiB
33
34// There is a helper for this.
35humanFormat.bytes(65536);
36//=> 64 kiB
37
38// A custom separator can be specified.
39humanFormat(1337, {
40  separator: " - ",
41});
42//=> 1.34 - k
43
44// Custom scales can be created!
45var timeScale = new humanFormat.Scale({
46  seconds: 1,
47  minutes: 60,
48  hours: 3600,
49  days: 86400,
50  months: 2592000,
51});
52humanFormat(26729235, { scale: timeScale });
53//=> 10.31 months
54
55// Helper when the scale is regular, i.e. prefixes are powers of a constant factor
56var binaryScale = humanFormat.Scale.create(["", "Ki", "Mi", "Gi", "Ti"], 1024);
57humanFormat(173559053, { scale: binaryScale });
58//=> 165.52 Mi
59
60// You can force a prefix to be used.
61humanFormat(100, { unit: "m", prefix: "k" });
62//=> 0.1 km
63
64// You can access the raw result.
65humanFormat.raw(100, { prefix: "k" });
66//=> {
67//   prefix: 'k',
68//   value: 0.09999999999999999 // Close value, not rounded.
69// }

Parsing

1humanFormat.parse("1.34 kiB", { scale: "binary" });
2//=> 1372.16
3
4// Fallbacks when possible if the prefix is incorrectly cased.
5humanFormat.parse("1 g");
6// => 1000000000
7
8// You can access the raw result.
9humanFormat.parse.raw("1.34 kB");
10//=> {
11//  factor: 1000,
12//  prefix: 'k',
13//  unit: 'B',
14//  value: 1.34
15//}

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

• report any issue you've encountered;
• fork and create a pull request.

Contributors:

• @djulien
• @qrohlf
• @Itay289
• @sweetpi

License

ISC © Julien Fontanet