Git Product home page Git Product logo

to-words's Introduction

Number to Words

Introduction

Converts Numbers (including decimal points) into words. It also converts the numbers into words for currency.

Installation

npm install to-words --save

Usage

Importing

const { ToWords } = require('to-words');

OR

import { ToWords } from 'to-words';

Config Options

const toWords = new ToWords({
  localeCode: 'en-IN',
  converterOptions: {
    currency: true,
    ignoreDecimal: false,
    ignoreZeroCurrency: false,
    doNotAddOnly: false,
    currencyOptions: { // can be used to override defaults for the selected locale
      name: 'Rupee',
      plural: 'Rupees',
      symbol: '₹',
      fractionalUnit: {
        name: 'Paisa',
        plural: 'Paise',
        symbol: '',
      },
    }
  }
});

Options can be set at instance level, or along with individual call to convert method.

const toWords = new ToWords();

let words = toWords.convert(123);
// words = One Hundred Twenty Three

words = toWords.convert(123.45);
// words = One Hundred Twenty Three Point Fourty Five

words = toWords.convert(123.045);
// words = One Hundred Twenty Three Point Zero Four Five

Note: When fractional part starts with zero, the digits after decimal points are converted into respective numbers individually

To convert to currency

const toWords = new ToWords();

let words = toWords.convert(452, { currency: true });
// words = Four Hundred Fifty Two Rupees Only

words = toWords.convert(452.36, { currency: true });
// words = Four Hundred Fifty Two Rupees And Thirty Six Paise Only

To discard fractional unit

const toWords = new ToWords();

let words = toWords.convert(452.36, { currency: true, ignoreDecimal: true });
// words = Four Hundred Fifty Two Rupees Only

To ignore major currency number when it's zero

const toWords = new ToWords();

let words = toWords.convert(0.572, { currency: true, ignoreZeroCurrency: true });
// words = Five Hundred Seventy Two Paise Only

Options

Option Type Default Description
localeCode string 'en-IN' Locale code for selecting i18n.
currency boolean false Whether the number to be converted into words written as currency.
Note: When currency:true, number will be rounded off to two decimals before converting to words
ignoreDecimal boolean false Whether to ignore fractional unit of number while converting into words.
ignoreZeroCurrency boolean false Whether to ignore zero currency value while converting into words.
doNotAddOnly boolean false Do not add only at the end of the words. This works only when currency = true
currencyOptions object undefined By default currency options are taken from the specified locale.
This option allows to specify different currency options while keeping the language details from the selected locale (e.g. convert to English text but use EUR as a currency). You can define different currencies for each call to convert() so it works also if you need to dynamically support multiple currencies.
This works only when currency = true

Supported Locale

Country Language Locale
UAE English en-AE
Bangladesh English en-BD
UK English en-GB
Ghana English en-GH
India English en-IN (default)
Myanmar English en-MM
Mauritius English en-MU
Nigeria English en-NG
Nepal English en-NP
USA English en-US
Iran Persian fa-IR
France French fr-FR
India Gujarati gu-IN
India Hindi hi-IN
India Marathi mr-IN
Suriname Dutch nl-SR
Brazil Portuguese pt-BR
Turkey Turkish tr-TR
Latvia Latvian lv-LV

Inspiration for core logic

https://stackoverflow.com/a/46221860

to-words's People

Contributors

akoso avatar blue-predator avatar dalirnet avatar deepsourcebot avatar dependabot-preview[bot] avatar dependabot[bot] avatar dueka avatar fijinapdt avatar florianchappaz avatar masihjahangiri avatar mastermunj avatar oskarspakers avatar rhyso avatar rittme avatar rubek-joshi avatar saifergit avatar wocodes avatar

Watchers

 avatar

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.