This NodeJs library enables you to create spoken format for numbers that represent an amount in countries currency .
using npm :
$ npm i num-to-txt --save
const Amount = require("num-to-txt");
const amount = new Amount(10239876);
// defualt language set to "EN"
// you can change it by passing as second parameter like this :
const amountWithCountry = new Amount(10239876, "Fa");
To group digits by three, use
// The settings are optional,
// you can pass it as object
const withDigitGrouping = amount.digitGrouped(); // returns 10,239,876
- amount
- groupDigitBy || default value set to 3, means divide number three digit, three digit
- numbersInEnglishCharcters || defult value set to false, it means your number is shown as entered Country if you want to show in english charchers set it to true
- decimalCount || defult value set to 0, it means if yor number is float it rounds up your number and show that without any decimals, if you want to see number with decimal, set the decimal count
- comma || defult value set to ",", it means you get numbers like this 12,555
for Ex :
// language = "FA"
const withDigitGrouping = amount.digitGrouped({ comma : "،" }); // returns ۱۰،۲۳۹،۸۷۶
const withDigitGrouping = amount.digitGrouped({ numbersInEnglishCharcters : true }); // returns 10,239,876
or
const withDigitGrouping = amount.digitGrouped({ groupDigitBy: 2 }); // returns 10,23,98,76
To display spoken format, use
/*
** language = "FA"
** The settings are optional,
** you can pass it as object
*/
const textFormat = amount.toText(); // returns ده میلیون و دویست و سی و نه هزار و هشتصد و هفتاد و شش
- withDecimals || default value is false, if you want to convert float part to text put it to true
- badge
- secondBadge || it works if you set withDecimals to true
- seprator || it works if you set withDecimals to true
To display spoken format in Rials (IRR), use
const tomanFormat = amount.farsiFormatToman({ badge: "ریال" }); // returns ده میلیون و دویست و سی و نه هزار و هشتصد و هفتاد و شش ریال
1 - create a folder named YOUR-LANGUGE inside the numberToString folder
2 - look at the persian folder, inside the numberToString folder
3 - fill your folder like that
4 - edit and add your files to index.js inside the numberToString folder
5 - create a js file named YOUR-LANGUGE inside the functions/util folder
6 - edit and add your files to index.js inside the functions/util folder
7 - pull request