@stdlib/string-num2words

Convert a number to a word representation.

https://github.com/stdlib-js/string-num2words

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary

Keywords

javascript node node-js nodejs stdlib str string util utilities utility utils word words

Last synced: 6 months ago · JSON representation ·

Repository

Convert a number to a word representation.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 768 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

javascript node node-js nodejs stdlib str string util utilities utility utils word words

Created about 3 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

num2words

Convert a number to a word representation.

## Installation ```bash npm install @stdlib/string-num2words ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var num2words = require( '@stdlib/string-num2words' ); ``` #### num2words( value\[, options] ) Converts a number to a word representation. ```javascript 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. ```javascript 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 ```javascript 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' ```

## CLI

## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/string-num2words-cli ```

### Usage ```text Usage: num2words [options] [] Options: -h, --help Print this message. -V, --version Print the package version. --split sep Delimiter for stdin data. Default: '/\\r?\\n/'. --lang lang Language. Default: 'en'. ```

### Notes - If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes. ```bash # Not escaped... $ echo -n $'15\n23' | num2words --split /\r?\n/ # Escaped... $ echo -n $'15\n23' | num2words --split /\\r?\\n/ ``` - The implementation ignores trailing delimiters.

### Examples ```bash $ num2words '10' ten ``` To use as a [standard stream][standard-streams], ```bash $ echo -n '23' | num2words twenty-three ``` By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option. ```bash $ echo -n '10.3\t23.1' | num2words --split '\t' ten point three twenty-three point one ```

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 35

Last Year

Push event: 35

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- npm 25 last-month

Total dependent packages: 1
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 8
Total maintainers: 4

npmjs.org: @stdlib/string-num2words-cli

Convert a number to a word representation.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 2 Last month

Rankings

Forks count: 15.9%

Stargazers count: 17.3%

Average: 31.0%

Dependent repos count: 37.3%

Dependent packages count: 53.5%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

npmjs.org: @stdlib/string-num2words

Convert a number to a word representation.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 4
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 23 Last month

Rankings

Dependent repos count: 37.3%

Average: 45.4%

Dependent packages count: 53.5%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v2 composite
act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/publish_cli.yml actions

JS-DevTools/npm-publish v2 composite
act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v2 composite
actions/checkout v3 composite
actions/setup-node v3 composite

package.json npm

@stdlib/assert-is-browser ^0.1.0 development
@stdlib/assert-is-string ^0.1.0 development
@stdlib/assert-is-windows ^0.1.0 development
@stdlib/bench ^0.1.0 development
@stdlib/constants-float64-ninf ^0.1.0 development
@stdlib/constants-float64-pinf ^0.1.0 development
@stdlib/process-exec-path ^0.1.0 development
@stdlib/string-replace ^0.1.0 development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-has-own-property ^0.1.0
@stdlib/assert-is-integer ^0.1.0
@stdlib/assert-is-number ^0.1.0
@stdlib/assert-is-plain-object ^0.1.0
@stdlib/assert-is-regexp-string ^0.1.0
@stdlib/cli-ctor ^0.1.0
@stdlib/fs-read-file ^0.1.0
@stdlib/math-base-assert-is-finite ^0.1.0
@stdlib/math-base-special-floor ^0.1.0
@stdlib/number-ctor ^0.1.0
@stdlib/process-read-stdin ^0.1.0
@stdlib/regexp-eol ^0.1.0
@stdlib/streams-node-stdin ^0.1.0
@stdlib/string-base-ends-with ^0.1.0
@stdlib/string-format ^0.1.0
@stdlib/utils-index-of ^0.1.0
@stdlib/utils-regexp-from-string ^0.1.0

@stdlib/string-num2words

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

num2words

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/string-num2words-cli

Rankings

Maintainers (4)

Funding

npmjs.org: @stdlib/string-num2words

Rankings

Maintainers (4)

Funding

Dependencies