# @amirsanni/number-to-words

> Convert numbers to words, with an optional country code.

Latest version **0.0.1** (published 2019-12-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install @amirsanni/number-to-words
pnpm add @amirsanni/number-to-words
yarn add @amirsanni/number-to-words
bun add @amirsanni/number-to-words
```

## 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.0.1 |
| Published | 2019-12-14 |
| First published | 2019-12-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Amir Sanni |
| Maintainers | amirsanni |
| Keywords | Number, Words, Figures, Convert |

## Links

- npm: https://www.npmjs.com/package/@amirsanni/number-to-words
- Repository: https://github.com/amirsanni/number-to-words-js
- Homepage: https://github.com/amirsanni/number-to-words-js#readme
- Issues: https://github.com/amirsanni/number-to-words-js/issues
- npm.io page: https://npm.io/package/@amirsanni/number-to-words

## 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

- 0.0.1 (latest) — 2019-12-14

## README

# number-to-words-js
A simple script to convert numbers/figures to words, with support for some currencies.

# Installation
```
npm install @amirsanni/number-to-words
```


# Supported Currency Codes
AED, AFN, ANG, ARS, AUD, BRL, CAD, CHF, CNY, DKK, DZD, EGP, EUR, GBP, GHC, GHS, HKD, ILS, INR, IQD, IRR, JMD, JOD, JPY, KES, KPW, KRW, KWD, LYD, MXN, MAD, MUR, NGN, NZD, PEN, PHP, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SHP, SYP, THB, TND, TRY, TWD, UGX, USD, VES, XAF, XCD, XOF, XPF, YER, ZAR.


# Test
_const convert = require('number-to-words');_

_convert(3490948028.56, "NGN");_

Returns **Three Billion, Four Hundred and Ninety Million, Nine Hundred and Forty-Eight Thousand, and Twenty-Eight Naira, Fifty-Six Kobo**.

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