# humanablenumber

> Package provides converting number to humanable format

Latest version **1.0.3** (published 2023-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install humanablenumber
pnpm add humanablenumber
yarn add humanablenumber
bun add humanablenumber
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-08-24 |
| First published | 2023-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | sportakal |
| Maintainers | szqii, sportakal |
| Keywords | humanable, number |

## Links

- npm: https://www.npmjs.com/package/humanablenumber
- Repository: https://github.com/sportakal/humanableNumber
- Homepage: https://github.com/sportakal/humanableNumber#readme
- Issues: https://github.com/sportakal/humanableNumber/issues
- npm.io page: https://npm.io/package/humanablenumber

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2023-08-24
- 1.0.2 — 2023-08-24
- 1.0.1 — 2023-08-24
- 1.0.0 — 2023-08-15

## README

# Humanable Number

[![npm version](https://badge.fury.io/js/humanablenumber.svg)](https://badge.fury.io/js/humanablenumber)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This package is used to convert a number to a human-readable format.

## Features

- Convert a number to a human-readable format
- Support for decimal numbers
- Support for numbers up to Quadrillion

## Installation

- Using NPM

   ```shell
  npm install humanablenumber
   ```

## Usage

1. Import the components into your project
   ```js
   import humanableNumber from "humanablenumber"
   ```
2. Use functions in your project
   ```js
    humanableNumber(1000) // 1K
    humanableNumber(10000) // 10K
    humanableNumber(987654, false) // 987K
    humanableNumber(987654, true) // 987.6K
    humanableNumber(1000000) // 1M
    humanableNumber(1000000000) // 1B
   ```

## API

| Option          | *Type*    |
|-----------------|-----------|
| **input**       | *number*  |
| **showDecimal** | *boolean* |

## Contributing

All contributions are welcome.

If you would like to contribute to this project, feel free to submit pull requests.

Prior to making significant changes, I recommend opening an issue to discuss the changes.

## License

This project is licensed under the MIT license. For more information, refer to the `LICENSE` file.

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