digione-num-to-words v0.0.1-alpha1

n2words

n2words is a library that converts a numerical number into a written number.

We have support for multiple languages (26 and growing) and our package is lightweight, modular and has no dependencies.

How To

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'})  // 'مائة و ثلاثة و عشرون'

Install

npm install n2words

n2words is also available on jsDelivr.

Usage

ESM

import n2words from 'n2words'

// Source file
import n2words from 'n2words/lib/n2words.mjs'

// Individual languages (recommended)
import n2wordsEN from 'n2words/lib/i18n/EN.mjs'

CommonJS

var n2words = require('n2words')

// Dynamic Import (source files)
import('n2words/lib/n2words.mjs').then(n2words => {
    // Available via "default" method
    n2words.default(100)
})

// Individual languages
import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
    n2wordsEN.default(100)
})

Browser

<script src="n2words.js"></script>

Features

• Cardinal numbers
• Decimal numbers
• Negative numbers

Supported Languages

• en (English, default)
• ar (Arabic)
• cz (Czech)
• dk (Danish)
• de (German)
• es (Spanish)
• fr (French)
• 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

You can help by adding new languages or by improving existing ones. Also, reporting issues, verifying the correctness of unit tests or adding more test cases is extremely helpful.

All help is welcome!

License

MIT