https://github.com/forzagreen/n2words

Convert numerical numbers to written numbers, in 25+ languages.
https://github.com/forzagreen/n2words

convert-numbers language natural-language nlp

Last synced: about 2 months ago
JSON representation

Convert numerical numbers to written numbers, in 25+ languages.

• Host: GitHub
• URL: https://github.com/forzagreen/n2words
• Owner: forzagreen
• License: mit
• Created: 2018-11-30T10:48:39.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-09T00:03:31.000Z (2 months ago)
• Last Synced: 2024-07-09T02:55:44.677Z (2 months ago)
• Topics: convert-numbers, language, natural-language, nlp
• Language: JavaScript
• Homepage:
• Size: 1.6 MB
• Stars: 83
• Watchers: 4
• Forks: 21
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-arabic - n2words - Convert numerical numbers to written numbers, in arabic (and other languages). (Programming Languages)

README

        
# n2words

[![Test](https://github.com/forzagreen/n2words/workflows/Test/badge.svg?branch=master)](https://github.com/forzagreen/n2words/actions)

[![Coverage Status](https://coveralls.io/repos/github/forzagreen/n2words/badge.svg?branch=master)](https://coveralls.io/github/forzagreen/n2words?branch=master)

[![npm](https://img.shields.io/npm/v/n2words.svg)](https://npmjs.com/package/n2words)

[![npm](https://img.shields.io/npm/dw/n2words)](https://npmjs.com/package/n2words)

[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/n2words/badge)](https://www.jsdelivr.com/package/npm/n2words)

__n2words__ converts numerical numbers into written ones, supports [27 languages](https://github.com/forzagreen/n2words#supported-languages), and has zero dependencies.

## Example

```js

n2words(123)   // 'one hundred and twenty-three'

n2words(-1.5)  // 'minus one point five'

n2words(123, {lang: 'fr'})  // 'cent vingt-trois'

n2words(123, {lang: 'es'})  // 'ciento veintitrés'

n2words(123, {lang: 'ar'})  // 'مائة و ثلاثة و عشرون'

```

See the [Wiki](https://github.com/forzagreen/n2words/wiki) for examples and advanced usage like [importing only specific languages](https://github.com/forzagreen/n2words/wiki/Importing-only-specific-languages).

## Install

```sh

npm install n2words

```

## Usage

### ESM

```js

import n2words from 'n2words'

```

### CommonJS ([dynamic import](https://nodejs.org/api/esm.html#import-expressions))

```js

import('n2words').then(({default: n2words}) => {

    n2words(100)

})

```

### Browser

```html

    n2words(100)

```

n2words is also available on [jsDelivr](https://www.jsdelivr.com/package/npm/n2words).

## Supported Languages

- `en` (English, default)

- `ar` (Arabic)

- `az` (Azerbaijani)

- `cz` (Czech)

- `dk` (Danish)

- `de` (German)

- `es` (Spanish)

- `fr` (French)

- `fr-BE` (French (Belgium))

- `fa` (Farsi)

- `he` (Hebrew)

- `hr` (Croatian)

- `hu` (Hungarian)

- `id` (Indonesian)

- `it` (Italian)

- `ko` (Korean)

- `lt` (Lithuanian)

- `lv` (Latvian)

- `nl` (Dutch)

- `no` (Norwegian)

- `pl` (Polish)

- `pt` (Portuguese)

- `ru` (Russian)

- `sr` (Serbian)

- `tr` (Turkish)

- `uk` (Ukrainian)

- `vi` (Vietnamese)

- `zh` (Chinese)

## Contributing

__This library is in active development.__ We want to improve the design and process for language contributors and add more languages. Bug reports and feature requests are also beneficial!

## License

[MIT](https://github.com/forzagreen/n2words/blob/master/LICENSE)