@nickfaughey/format-si-prefix

0.4.5 • Public • Published

format-si-prefix

npm David David

Format and unformat numbers with SI prefixes.

API

formatSI()

import {formatSI} from 'format-si-prefix';
const string = formatSI(number, options);     // optional `options` object

Options:

  • space: (default false) adds a space between the number and prefix (ex. 1.2 k)
  • sign: (default false) prepends a plus sign if the number is positive (ex. +1.2k)
  • suffix: appends a string to the formatted number (ex. formatSI(1200, {suffix: 'Wh'}) => 1.2kWh)
in out
... ...
0.000111111 111µ
0.00111 1.11m
0.0111 11.1m
0.111 111m
1 1
11 11
111 111
1111 1.11k
11111 11.1k
111111 111k
1111111 1.11M
... ...

unformatSI()

import {unformatSI} from 'format-si-prefix';
const number = unformatSI(string);
in out
... ...
111µ 0.000111
1.11m 0.00111
11.1m 0.0111
111m 0.111
1 1
11 11
111 111
1.11k 1110
11.1k 11100
111k 111000
1.11M 1110000
... ...
12.345M 12345000
12.345 12.345
1234567 1234567
123456M 123456000000
1000.1m 1.0001
... ...

License

MIT

Package Sidebar

Install

npm i @nickfaughey/format-si-prefix

Weekly Downloads

0

Version

0.4.5

License

MIT

Unpacked Size

8.34 kB

Total Files

5

Last publish

Collaborators

  • nickfaughey