https://github.com/garora/number2text
Provides the facility to convert number to text (currently supports only Indian and English style for number to text including currency (Indian Rupee and US Dollar))
https://github.com/garora/number2text
currency dollar indians javascript
Last synced: 5 months ago
JSON representation
Provides the facility to convert number to text (currently supports only Indian and English style for number to text including currency (Indian Rupee and US Dollar))
- Host: GitHub
- URL: https://github.com/garora/number2text
- Owner: garora
- License: other
- Created: 2015-04-02T13:14:54.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2021-08-20T13:47:14.000Z (almost 5 years ago)
- Last Synced: 2025-09-22T17:24:41.430Z (9 months ago)
- Topics: currency, dollar, indians, javascript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/number2text
- Size: 30.3 KB
- Stars: 5
- Watchers: 2
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Looking for contributors
Due to other stuffs, I'm unable to maintain the repository. There were plans to enhance the code with new langauge/conversions, if you have time and willing to help communities. You are the one who can contribute. Add your [plan](https://github.com/garora/number2text/issues) here and lets start it.
Number to Text
===
[](https://travis-ci.org/garora/number2text) [](https://coveralls.io/r/garora/number2text)
> Provides the facility to convert number to text.
* Default type is Indian for non-currency
* Default type is Indian Rupee for currency
* Indian style for number to text (Indian Rupee for currency)
* English style for number to text (US Dollar for currency)
## How to install?
```shell
npm install number2text
```
## How to use?
```js
var numberToText = require('number2text');
```
```js
var textDefault = numberToText(1000000); //it converts to default type i.e. Indian
console.log('Converts 1000000 to ', textDefault); //Converts 1000000 to Ten Lakh
```
```js
var textIndian = numberToText(1000000,'Indian');
console.log('Converts 1000000 to ', textIndian); //Converts 1000000 to Ten Lakh
```
```js
var textEnglish = numberToText(1000000,'English');
console.log('Converts 1000000 to ', textEnglish); //Converts 1000000 to One Million
```
```js
//Large values
var textIndian = numberToText(1000000000000);
var textEnglish = numberToText(1000000000000,'English');
console.log('Converts 1000000000000 to ', textIndian); //Converts 1000000000000 to One Lakh Crore
console.log('Converts 1000000000000 to ', textEnglish); //Converts 1000000000000 to One Trillion
```
```js
//For types other than Indian, English
var text = numberToText(100,"French");
console.log('Retuns message: ', text); //Return message: Support for language: french is not available. Available languages are: indian,english
```
```js
var defaultCurrency = numberToText(100.10,'',true);
console.log('Converts 100.10 to ', defaultCurrency); //Converts 100.10 to One Hundred Rupee And Ten Paise Only
```
```js
var defaultNonCurrency = numberToText(100.10);
console.log('Converts 100.10 to ', defaultNonCurrency); //Converts 100.10 to One Hundred Point Ten
```
## Executing tests
```shell
npm test
```
## Contribution
Just need to take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
```shell
git clone https://github.com/garora/number2text.git
cd number2text
```
### Contributors
Many thanks to all the contributors who spent their time to write code. Their contribution is priceless, A small gratitude for their contributions:
1. [Rishabh Desai](https://github.com/rishabdesai)
# Starting with pre-release installation
```shell
npm install git://github.com/garora/number2text.git
npm install git://github.com/garora/number2text.git#pre-releaseversion
```
## License
MIT
## Release notes
Currently ```number2text``` is in initial release. We're trying to make it more stable. Currently, it supports Indian standard to read numbers as words. Check for more details: [Change log](https://github.com/garora/number2text/blob/master/Changelog.md)
## Release history
* 0.0.0 Initial release
* 0.1.0 Initial release - Fixed few issues related to build
* 0.1.1 Few fixes
* 0.1.11 Typos
* 1.0.0 New feature
* 1.0.1 Added large number support
* 1.1.0 Added currency support
* 1.1.1 typos