number-to-words

What is number-to-words?

The number-to-words npm package is a utility for converting numbers into their word equivalents. It supports various functionalities such as converting numbers to words, ordinal words, and ordinal numbers.

What are number-to-words's main functionalities?

Convert number to words

This feature converts a given number into its word equivalent. For example, the number 123 is converted to 'one hundred twenty-three'.

const numberToWords = require('number-to-words');
console.log(numberToWords.toWords(123)); // 'one hundred twenty-three'

Convert number to ordinal words

This feature converts a given number into its ordinal word equivalent. For example, the number 123 is converted to 'one hundred twenty-third'.

const numberToWords = require('number-to-words');
console.log(numberToWords.toWordsOrdinal(123)); // 'one hundred twenty-third'

Convert number to ordinal number

This feature converts a given number into its ordinal number equivalent. For example, the number 123 is converted to '123rd'.

const numberToWords = require('number-to-words');
console.log(numberToWords.toOrdinal(123)); // '123rd'

Other packages similar to number-to-words

num-words

The num-words package provides similar functionality to number-to-words, allowing conversion of numbers to words. However, it may not support as many features such as ordinal words and ordinal numbers.

number-to-words-ru

The number-to-words-ru package is specifically designed for converting numbers to words in Russian. It offers similar functionality but is tailored for the Russian language, unlike number-to-words which is primarily for English.

words-to-numbers

The words-to-numbers package performs the reverse operation of number-to-words, converting words back into numbers. It complements number-to-words by providing the inverse functionality.

README

Number To Words

Contains some util methods for converting numbers into words, ordinal words and ordinal numbers.

Install

npm install number-to-words

API

toOrdinal(number)

Converts an integer into a string with an ordinal postfix. If number is decimal, the decimals will be removed.

var converter = require('number-to-words');
converter.toOrdinal(21); // => “21st”

toWords(number)

Converts an integer into words. If number is decimal, the decimals will be removed.

var converter = require('number-to-words');
converter.toWords(13); // => “thirteen”

// Decimal numbers:
converter.toWords(2.9); // => “two”

// Negative numbers:
converter.toWords(-3); // => “minus three”

// Large numbers:
converter.toWords(9007199254740992); // => “nine quadrillion, seven trillion, one hundred ninety-nine billion, two hundred fifty-four million, seven hundred forty thousand, nine hundred ninety-two”

toWordsOrdinal(number)

Converts a number into ordinal words. If number is decimal, the decimals will be removed.

var converter = require('number-to-words');
converter.toWordsOrdinal(21); // => “twenty-first”

Contributions, Comments and Bugs

Contributions, comments and/or bug reports are much appreciated. Open a pull request or add comments on the issues page. Thanks!

Upcoming v2.0

See roadmap for details.

Change Log

Version 1.2.0 (final 1.x release)

• Bundles are now available for browsers (./numberToWords.js and ./numberToWords.min.js). They export a global numberToWords variable.
• Made unit tests runnable in browser. To run the unit tests in the browser, start a local server and visit localhost/spec with a browser.
• toOrdinal, toWords and toWordsOrdinal now also allow string values as input (replaced Math.floor with parseInt).

1.1.0

• New methods toOrdinal and toWordsOrdinal
• Deprecated toWords second optional asOrdinal parameter, use toWordsOrdinal()-method instead
• toWords now converts any decimal input to an integer (with Math.floor)
• Bug fixed returning “zeroth” instead of “zero” when converting a number word into its ordinal

1.0.1

• Minor package tweaks

1.0.0

• Initial release