Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nisaacson/number-string-representation
Take a decimal number and convert it to its string representation in node.js
https://github.com/nisaacson/number-string-representation
Last synced: about 1 month ago
JSON representation
Take a decimal number and convert it to its string representation in node.js
- Host: GitHub
- URL: https://github.com/nisaacson/number-string-representation
- Owner: nisaacson
- Created: 2013-06-17T22:07:57.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-06-18T18:16:46.000Z (over 11 years ago)
- Last Synced: 2024-08-09T04:47:17.072Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Number String Representation
[](https://travis-ci.org/nisaacson/number-string-representation)
[](https://david-dm.org/nisaacson/number-string-representation)
Take a decimal number and convert it to a string representation. For example if you have the number `2523.04`, this module will convert `2523.04` to `"Two thousand five hundred twenty-three and 04/100 dollars"`
# Installation
```bash
npm install -g number-string-representation
```
# Requirements
The module requires that you have the `node` and `npm` binaries installed and available on your path. The latest version node.js is available [here](http://nodejs.org/download/) and includes the npm binary as well
# Usage
The module can be used either as a stand-alone command line tool or within other javascript code. The module has only been tested on node.js versions 0.8 & 0.10 but should work in the browser without issues
As a command line tool
```bash
number-string-representation --number="2523.04"
# outputs "Two thousand five hundred twenty-three and 04/100 dollars"
```
For usage of the command line tool execute the command with no option parameters specified
```bash
number-string-representation
# prints out usage information
```
As a module within your own code. Note that you must pass a valid number as the input parameter to module function. String numbers will throw an exception
Valid input parameter example
```javascript
var numberStringRepresentation = require('number-string-representation')
var input = 2523.04
var output = numberStringRepresentation(input)
console.log('output: %s', output)
```
Invalid input parameter example
```javascript
var numberStringRepresentation = require('number-string-representation')
var input = '2523.04'
var output = numberStringRepresentation(input) // will throw an error here
console.log('output: %s', output)
```
# Negative numbers
If you supply a negative number as an input, the output will be prepended with the text 'Negative '
```javascript
var numberStringRepresentation = require('number-string-representation')
var input = -2523.04
// output === 'Negative two thousand five hundred twenty-three and 04/100 dollars'
Ne output = numberStringRepresentation(input)
console.log('output: %s', output)
```
When using negative numbers with the command line tool, you must pass them using both the equals sign and quotation marks around your value
```bash
number-string-representation --number="-2523.04"
# outputs "Negative two thousand five hundred twenty-three and 04/100 dollars"
```
The following will not work and will instead throw an error. Note that the equals sign from the example above is missing here:
```bash
number-string-representation --number "-2523.04"
```
# Limitations
Currently the module only supports numbers in the range [-999999999999999, 999999999999999], which corresponds to negative trillions to positive trillions.
If you input a number with fractional cents, they will always be rounded down. For example
```bash
number-string-representation --number=".546"
# will output "Zero and 54/100 dollars"
```
# Test
```bash
# install the development dependencies
npm install
# run the tests
npm test
```