# spell-out

> This will help convert number to its alphabetical equivalent form.

Latest version **0.2.0** (published 2019-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install spell-out
pnpm add spell-out
yarn add spell-out
bun add spell-out
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-12-25 |
| First published | 2019-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mujib Ansari |
| Maintainers | macos |
| Keywords | Number, to, Words, Spell, Out |

## Links

- npm: https://www.npmjs.com/package/spell-out
- Repository: https://github.com/mujib2953/SpellOut
- Homepage: https://github.com/mujib2953/SpellOut#readme
- Issues: https://github.com/mujib2953/SpellOut/issues
- npm.io page: https://npm.io/package/spell-out

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2019-12-25
- 0.1.0 — 2019-12-04
- 0.0.3 — 2019-11-29
- 0.0.2 — 2019-11-28
- 0.0.1 — 2019-11-28

## README

# SpellOut

This will help convert number to its alphabetical equivalent form.

Example:
```javascript
const { SpellOut } = require("spell-out");

SpellOut(12345678); // -- One Crore Twenty Three Lakh Fourty Five Thousand Six Hundred Seventy Eight

SpellOut("12345678"); // -- One Crore Twenty Three Lakh Fourty Five Thousand Six Hundred Seventy Eight

```

Example with `format` parameter:
- By default `format` is set to **`I`**, which stands for **INDIAN FORMAT**
- So we don't have to pass it if we want output in indian format.
- Other option for `format` is **`U`**, which stands for **INTERNATIONAL FORMAT**
- Below code depicts the same example as above but with "**U**" format.
```javascript
SpellOut("12345678", "U"); // --- Twelve Million Three Hundred and Forty Five Thousand Six Hundred and Seventy Eight
```

TODOs:
- [x] USD output format _(This is completed planned in next released)_
- [ ] Support for comma seperated numbers, like **12,345,678** or **1,23,45,678**
- [ ] Support for larger number till `Number.MAX_SAFE_INTEGER`

### Bugs
- [External Bugs](https://github.com/mujib2953/SpellOut/issues) raised by other github user.
- [Internal Bugs](https://github.com/mujib2953/SpellOut/blob/master/bugList.md) found in internal testing.

# App
Author: Mujibur Rehman

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