thousands-counter
v2.1.1
Published
convert thousands of number to human representation (K, M, B)
Downloads
409
Maintainers
Readme
thousands-counter
Thousands Counter is a package that allows you to convert numbers above the thousands into its abbreviated form.
This package can be useful for statistics or social media projects to convert number of followers, likes and posts, as well as other statistical information for site such as Instagram, Facebook, Pinterest etc.
Example
You can test online: (https://thousands-counter.netlify.com/)
The numbers will abbreviate in the following way:
Installation
The package is available as an npm package. To install the package run:
npm install thousands-counter
# or with yarn
yarn add thousands-counter
Usage v2.0.0
//default config
tc(number, {digits: 1, uppercase: true})
import tc from 'thousands-counter';
console.log('Default: ', tc(1580));
// Default: 1K
console.log('Default: ', tc(1580, {digits: 2}));
// Default: 1.58K
console.log('Counter: ', tc(1580, {digits: 2, uppercase: false}));
// Counter: 1.58k
Options
- digits: (number) Print the decimal, by default 1
- uppercase: (boolean) Print K, M, B like uppercase, by default is true.
Notes:
- Facebook, Twitter and Youtube uses Uppercase. (Ex: 1.5K, 4.5M)
- Instagram uses Lowercase. (Ex. 1.5k, 4.5m)
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.