prettydigits
v1.1.3
Published
Prettifies large numbers into readable human numbers
Downloads
139
Maintainers
Readme
PrettyDigits
Changes long 'ugly' numbers
into short pretty and readable strings
🌸
Install with NPM
npm i prettydigits
| Before | Command | After |
|-------------|-------------|-------------|
| 1000
| prettyDigits(1000)
| '1 K'
|
| 10000
| prettyDigits(10000)
| '10 K'
|
| 1000000
| prettyDigits(1000000)
| '1 M'
|
| 0.0004356
| prettyDigits(0.0004356)
| '0.0004'
|
| 100
| prettyDigits(100,{units:['b']})
| '100 b'
|
| -1250
| prettyDigits(-1250,{precision: 2})
| '-1.25 K'
|
Useage
import {prettyDigits} from 'prettyDigits'
//or
const {prettyDigits} = require('prettyDigits');
prettyDigits(3500); // '4 K'
prettyDigits(1293943, {precision: 3, tolowercase: true}) // '1.294 m'
prettyDigits(-12345, {space: false, units: ['b','kb','mb','gb','tb']}) // '-12kb'
prettyDigits(0.005431351234, {precision: 2}) // '0.00543'
prettyDigits(0.000000765) // '7.65e-7' also applies for negative numbers
Numbers that are lower than 1e-7 get a scientific notion string returned.
Options
| Name | Type | Default Values | Description |
|---------------|-----------|------------------------|----------------------------------------------|
| precision
| number
| 0
| Number of decimal places to use. If the number is between 1 and 0 the precision starts at where the trailing zeros end. Eg prettyDigits(0.0053,{precision: 0})
= '0.005'
|
| tolowercase
| boolean
| false
| Change abbreviation to lower case |
| space
| boolean
| true
| Adds a space between abbreviation and number |
| units
| Array
| ["","K","M","B","T"]
| Change the units to your own custom ones |