num2words

Convert a number to a word representation.

Installation

npm install @stdlib/string-num2words

Usage

var num2words = require( '@stdlib/string-num2words' );

num2words( value[, options] )

Converts a number to a word representation.

var out = num2words( 87 );
// returns 'eighty-seven'

out = num2words( 23101 );
// returns 'twenty-three thousand one hundred one'

out = num2words( 0.53 );
// returns 'zero point five three'

The function accepts the following options:

• lang: string indicating the language. Default: 'en'.

By default, the function returns a word representation of a number in English. To return a word representation of a number in a different language, set the lang option.

var out = num2words( 22, {
    'lang': 'de'
});
// returns 'zweiundzwanzig'

out = num2words( 0.53, {
    'lang': 'de'
});
// returns 'null Komma fünf drei'

Notes

• The following languages are supported:

  • en: English.
  • de: German.

Examples

var num2words = require( '@stdlib/string-num2words' );

var out = num2words( 29 );
// returns 'twenty-nine'

out = num2words( 113 );
// returns 'one hundred thirteen'

out = num2words( 13.52 );
// returns 'thirteen point five two'

out = num2words( 47, {
    'lang': 'de'
});
// returns 'siebenundvierzig'

See Also

• @stdlib/string-num2words-cli: CLI package for use as a command-line utility.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.