An open API service indexing awesome lists of open source software.

https://github.com/gustavochavarria/thousands-counter

Counter for followers, likes, post and others stats on Social Networks
https://github.com/gustavochavarria/thousands-counter

counter-social-network hacktoberfest hacktoberfest2021 javascript library

Last synced: about 1 year ago
JSON representation

Counter for followers, likes, post and others stats on Social Networks

Awesome Lists containing this project

README

          

# thousands-counter

[![npm version](https://badge.fury.io/js/thousands-counter.svg)](https://badge.fury.io/js/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:


1,000
➡️
1K


2,800
➡️
2.8K


99,800
➡️
99.8K


1,000,000
➡️
1M


You can use negative numbers

-1,000
➡️
-1K

## Installation
The package is available as an [npm package](https://www.npmjs.com/package/thousands-counter).
To install the package run:

```bash
npm install thousands-counter
# or with yarn
yarn add thousands-counter
```

## Usage v2.0.0
```js
//default config
tc(number, {digits: 1, uppercase: true})
```

```js
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.