# number-abbrevation

> This package involves representing large numbers in a shorter, more convenient format by using abbreviations such as "k" for thousand and "m" for million and etcc

Latest version **1.0.7** (published 2023-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install number-abbrevation
pnpm add number-abbrevation
yarn add number-abbrevation
bun add number-abbrevation
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2023-03-27 |
| First published | 2023-03-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nagasai Kotha |
| Maintainers | nagasaikotha |
| Keywords | number-abbrevation, number-formatting, number-scaling |

## Links

- npm: https://www.npmjs.com/package/number-abbrevation
- npm.io page: https://npm.io/package/number-abbrevation

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2023-03-27
- 1.0.6 — 2023-03-21
- 1.0.5 — 2023-03-20
- 1.0.4 — 2023-03-20
- 1.0.3 — 2023-03-17
- 1.0.2 — 2023-03-14
- 1.0.1 — 2023-03-14
- 1.0.0 — 2023-03-14

## README

# Number Abbrevation

This package helps you represent large numbers in a shorter, more convenient format by using abbreviations such as "k" for thousand and "m" for million. It is especially useful when dealing with financial or statistical data.



## Installation

To use Number-Abbreviation in your project, simply install it via npm:


```bash
  npm install number-abbrevation

```
    
## Usage

The formatNumber() function takes a number as input and returns its abbreviated form, with a suffix indicating the order of magnitude. For example:
```javascript

const numberAbbreviation = require('number-abbrevation');

console.log(numberAbbreviation.formatNumber(1234567)); // Output: 1.2M
```

The deAbbreviateNumber() function takes an abbreviated number as input and returns its full numeric value. For example:
```javascript

const numberAbbreviation = require('number-abbrevation');

console.log(numberAbbreviation.deAbbreviateNumber('1K')); // 1000
```


## Features

- Easy-to-use API that allows you to quickly and easily format large numbers
- Supports numbers up to the trillions
- Customizable labels for abbreviations
- Cross platform
- MIT License



## Contributing

Contributions are always welcome!

If you'd like to contribute to this project, please feel free to fork the repository and submit a pull request. We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements.
## Authors

- [nagasaikotha](https://in.linkedin.com/in/nagasaikotha)



## License

This project is licensed under the terms of the MIT license. See the LICENSE file for more information.

---
_Source: https://npm.io/package/number-abbrevation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._