Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 1.65 KB

README.md

File metadata and controls

82 lines (60 loc) · 1.65 KB
Raw

n2words

Node CI Coverage Status npm

n2words converts numbers to words. It supports multiple languages.

n2words is a lightweight, easy to use package, with no dependencies. It works both in Node.js and in browsers.

Install

npm install n2words

n2words is available on jsDelivr.

Usage

CommonJS

var n2words = require('n2words')

ES6

import n2words from 'n2words'
// or to import source ES Modules without bundle and polyfills
import n2words from 'n2words/lib/n2words.mjs'

Browser

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

Example

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

n2words(123, {lang: 'en'}) // 'one hundred and twenty-three'
n2words(123, {lang: 'fr'}) // 'cent vingt-trois'
n2words(123, {lang: 'es'}) // 'ciento veintitrés'

Features

  • Cardinal numbers
  • Decimal numbers

Supported Languages

  • en (English, default)
  • ar (Arabic)
  • cz (Czech)
  • dk (Danish)
  • de (German)
  • es (Spanish)
  • fr (French)
  • fa (Farsi)
  • he (Hebrew)
  • it (Italian)
  • ko (Korean)
  • lt (Lithuanian)
  • lv (Latvian)
  • nl (Dutch)
  • no (Norwegian)
  • pl (Polish)
  • pt (Portuguese)
  • ru (Russian)
  • sr (Serbian)
  • tr (Turkish)
  • uk (Ukrainian)

License

MIT