GithubHelp home page GithubHelp logo

garora / number2text Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 9.0 31 KB

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))

Home Page: https://www.npmjs.com/package/number2text

License: Other

Makefile 10.44% JavaScript 89.56%
javascript indians currency dollar

number2text's Introduction

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 here and lets start it.

Number to Text

Build Status Coverage Status

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?

  npm install number2text

How to use?

  var numberToText = require('number2text');
     
  var textDefault = numberToText(1000000); //it converts to default type i.e. Indian

  console.log('Converts 1000000 to ', textDefault); //Converts 1000000 to Ten Lakh
       
  var textIndian = numberToText(1000000,'Indian');

  console.log('Converts 1000000 to ', textIndian); //Converts 1000000 to Ten Lakh
       
  var textEnglish = numberToText(1000000,'English');

  console.log('Converts 1000000 to ', textEnglish); //Converts 1000000 to One Million
       
  //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
       
  //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
       
  var defaultCurrency = numberToText(100.10,'',true);

  console.log('Converts 100.10 to ', defaultCurrency); //Converts 100.10 to One Hundred Rupee And Ten Paise Only
       
  var defaultNonCurrency = numberToText(100.10);

  console.log('Converts 100.10 to ', defaultNonCurrency); //Converts 100.10 to One Hundred Point Ten 

Executing tests

   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.

  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

Starting with pre-release installation

  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

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

number2text's People

Contributors

garora avatar rishabdesai avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

number2text's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.