![\"npm](\"https://img.shields.io/npm/v/@codeshumon/number-to-words.svg\")
\r\n\r\n\r\n![\"License:](\"https://img.shields.io/badge/License-MIT-blue.svg\"){kind=icon}
\r\n\r\n\r\nConvert numbers to words with currency formatting for 130+ countries. Perfect for invoices, checks, and financial applications.\r\n
\r\n\r\n\r\n\r\nTable of Contents\r\n\r\n123 ā \"One Hundred Twenty Three\")npm install @codeshumon/number-to-words\r\n\r\nor\r\n\r\nyarn add @codeshumon/number-to-words\r\nconst { toWords } = require('@codeshumon/number-to-words');\r\n\r\nconsole.log(toWords(125.55));\r\n// Output: \"One Hundred Twenty Five and Point Five Five\"\r\n\r\nconsole.log(toWords(588532654484815));\r\n// Output: \"Five Hundred Eighty Eight Trillion Five Hundred Thirty Two Billion Six Hundred Fifty Four Million Four Hundred Eighty Four Thousand Eight Hundred Fifteen\"\r\nconst { toCurrencyWords } = require('@codeshumon/number-to-words');\r\n\r\n// US Dollars\r\nconsole.log(toCurrencyWords(1234.56, 'US'));\r\n// \"One Thousand Two Hundred Thirty Four Dollars and Fifty Six Cents Only\"\r\n\r\n// British Pounds\r\nconsole.log(toCurrencyWords(789.12, 'GB'));\r\n// \"Seven Hundred Eighty Nine Pounds and Twelve Pence Only\"\r\n\r\n// Indian Rupees\r\nconsole.log(toCurrencyWords(4567.89, 'IN'));\r\n// \"Four Thousand Five Hundred Sixty Seven Rupees and Eighty Nine Paise Only\"\r\nimport { toWords, toCurrencyWords } from '@codeshumon/number-to-words';\r\n\r\nconsole.log(toWords(2023));\r\n// Output: \"Two Thousand Twenty Three\"\r\n\r\nconsole.log(toCurrencyWords(2500.75, 'US'));\r\n// Output: \"Two Thousand Five Hundred Dollars and Seventy Five Cents Only\"\r\n<script src=\"https://unpkg.com/@codeshumon/number-to-words\"></script>\r\nconst { toWords, toCurrencyWords } = window.NumberToWords;\r\n\r\nconsole.log(toWords(999.99));\r\n// Output: \"Nine Hundred Ninety Nine and Point Nine Nine\"\r\n\r\nconsole.log(toCurrencyWords(999.99, 'US'));\r\n// Output: \"Nine Hundred Ninety Nine Dollars and Ninety Nine Cents Only\"\r\ntoCurrencyWords(-100.50, 'US');\r\n// \"Negative One Hundred Dollars and Fifty Cents Only\"\r\ntoWords(1000000000000);\r\n// \"One Trillion\"\r\nconst { toWords } = require('@codeshumon/number-to-words');\r\n\r\nconsole.log(toWords(652222225.52226));\r\n// Output: \"Six Hundred Fifty-two Million, Two Hundred Twenty-two Thousand, Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords('4322222225.52226', { noHypen: true }));\r\n// Output: \"Four Billion, Three Hundred Twenty Two Million, Two Hundred Twenty Two Thousand, Two Hundred Twenty Five Point Five Two\"\r\n\r\nconsole.log(toWords('4322222225.52226', { noComa: true }));\r\n// Output: \"Four Billion Three Hundred Twenty-two Million Two Hundred Twenty-two Thousand Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords(2522222225.52226, {isAnd : true }));\r\n// Output: \"Two Billion and Five Hundred Twenty-two Million and Two Hundred Twenty-two Thousand and Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords('9222222225.8226', {titleCase : true}));\r\n// Output: \"Nine Billion, Two Hundred Twenty-Two Million, Two Hundred Twenty-Two Thousand, Two Hundred Twenty-Five Point Eight Two\"\r\n\r\nconsole.log(toWords(4022222225.6226, { titleCase : true, isAnd : true, noHypen: true }));\r\n// Output: \"Four Billion and Twenty Two Million and Two Hundred Twenty Two Thousand and Two Hundred Twenty Five Point Six Two\"\r\nconst { toCurrencyWords } = require('@codeshumon/number-to-words');\r\n\r\n// Default (assuming 'US' if no currency provided or unrecognized)\r\nconsole.log(toCurrencyWords('115255500015.58780'));\r\n// Output: \"One Hundred Fifteen Billion, Two Hundred Fifty-five Million, Five Hundred Thousand, Fifteen Dollars and Fifty-nine Cents only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.2500', 'GB',));\r\n// Output: \"Five Trillion, Five Hundred Fifty-two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Twenty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.5500', 'GB', {noHypen: true}));\r\n// Output: \"Five Trillion, Five Hundred Fifty Two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Fifty Five Pence only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.5500', 'GB', {noComa: true}));\r\n// Output: \"Five Trillion Five Hundred Fifty-two Billion One Hundred Eleven Million One Hundred Eleven Thousand One Hundred Fifteen Pounds and Fifty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.6500, 'GB', {isAnd : true }));\r\n// Output: \"Five Trillion and Five Hundred Fifty-two Billion and One Hundred Eleven Million and One Hundred Eleven Thousand and One Hundred Fifteen Pounds and Sixty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.9500, 'GB', {titleCase : true}));\r\n// Output: \"Five Trillion, Five Hundred Fifty-Two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Ninety-Five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.750, 'GB', { titleCase : true, isAnd : true, noHypen: true }));\r\n// Output: \"Five Trillion and Five Hundred Fifty Two Billion and One Hundred Eleven Million and One Hundred Eleven Thousand and One Hundred Fifteen Pounds and Seventy Five Pence only\"\r\nimport { toWords, toCurrencyWords } from '@codeshumon/number-to-words';\r\n\r\nconsole.log(toWords(2023));\r\n// Output: \"Two Thousand Twenty Three\"\r\n\r\nconsole.log(toCurrencyWords(2500.75, 'US'));\r\n// Output: \"Two Thousand Five Hundred Dollars and Seventy Five Cents Only\"\r\n\r\nconsole.log(toWords(652222225.52226));\r\n// Output: \"Six Hundred Fifty-two Million, Two Hundred Twenty-two Thousand, Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.2500', 'GB',));\r\n// Output: \"Five Trillion, Five Hundred Fifty-two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Twenty-five Pence only\"\r\nInclude the script in your HTML:
\r\n\r\n<script src=\"https://unpkg.com/@codeshumon/number-to-words\"></script>\r\nThen, you can access the functions globally:
\r\n\r\nconst { toWords, toCurrencyWords } = window.NumberToWords;\r\n\r\nconsole.log(toWords(999.99));\r\n// Output: \"Nine Hundred Ninety Nine and Point Nine Nine\"\r\n\r\nconsole.log(toCurrencyWords(999.99, 'US'));\r\n// Output: \"Nine Hundred Ninety Nine Dollars and Ninety Nine Cents Only\"\r\n\r\nconsole.log(toCurrencyWords('115255500015.58780'));\r\n// Output: \"One Hundred Fifteen Billion, Two Hundred Fifty-five Million, Five Hundred Thousand, Fifteen Dollars and Fifty-nine Cents only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.2500', 'GB',));\r\n// Output: \"Five Trillion, Five Hundred Fifty-two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Twenty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.5500', 'GB', {noHypen: true}));\r\n// Output: \"Five Trillion, Five Hundred Fifty Two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Fifty Five Pence only\"\r\n\r\nconsole.log(toCurrencyWords('5552111111115.5500', 'GB', {noComa: true}));\r\n// Output: \"Five Trillion Five Hundred Fifty-two Billion One Hundred Eleven Million One Hundred Eleven Thousand One Hundred Fifteen Pounds and Fifty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.6500, 'GB', {isAnd : true }));\r\n// Output: \"Five Trillion and Five Hundred Fifty-two Billion and One Hundred Eleven Million and One Hundred Eleven Thousand and One Hundred Fifteen Pounds and Sixty-five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.9500, 'GB', {titleCase : true}));\r\n// Output: \"Five Trillion, Five Hundred Fifty-Two Billion, One Hundred Eleven Million, One Hundred Eleven Thousand, One Hundred Fifteen Pounds and Ninety-Five Pence only\"\r\n\r\nconsole.log(toCurrencyWords(5552111111115.750, 'GB', { titleCase : true, isAnd : true, noHypen: true }));\r\n// Output: \"Five Trillion and Five Hundred Fifty Two Billion and One Hundred Eleven Million and One Hundred Eleven Thousand and One Hundred Fifteen Pounds and Seventy Five Pence only\"\r\n\r\nconsole.log(toWords(652222225.52226));\r\n// Output: \"Six Hundred Fifty-two Million, Two Hundred Twenty-two Thousand, Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords('4322222225.52226', { noHypen: true }));\r\n// Output: \"Four Billion, Three Hundred Twenty Two Million, Two Hundred Twenty Two Thousand, Two Hundred Twenty Five Point Five Two\"\r\n\r\nconsole.log(toWords('4322222225.52226', { noComa: true }));\r\n// Output: \"Four Billion Three Hundred Twenty-two Million Two Hundred Twenty-two Thousand Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords(2522222225.52226, {isAnd : true }));\r\n// Output: \"Two Billion and Five Hundred Twenty-two Million and Two Hundred Twenty-two Thousand and Two Hundred Twenty-five Point Five Two\"\r\n\r\nconsole.log(toWords('9222222225.8226', {titleCase : true}));\r\n// Output: \"Nine Billion, Two Hundred Twenty-Two Million, Two Hundred Twenty-Two Thousand, Two Hundred Twenty-Five Point Eight Two\"\r\n\r\nconsole.log(toWords(4022222225.6226, { titleCase : true, isAnd : true, noHypen: true }));\r\n// Output: \"Four Billion and Twenty Two Million and Two Hundred Twenty Two Thousand and Two Hundred Twenty Five Point Six Two\"\r\n| Option | \r\nType | \r\nDefault | \r\nDescription | \r\nEffect Example | \r\n
|---|---|---|---|---|
noComa | \r\n boolean | \r\nfalse | \r\nInclude or exclude commas between large number groups. | \r\n\r\n false: \"One Million, Two Hundred Thousand\" \r\n true: \"One Million Two Hundred Thousand\"\r\n | \r\n
isAnd | \r\n boolean | \r\nfalse | \r\nInsert the word and between number groups for formal reading. | \r\n \r\n false: \"One Million Two Hundred Thousand\" \r\n true: \"One Million and Two Hundred Thousand\"\r\n | \r\n
noHypen | \r\n boolean | \r\nfalse | \r\nRemove hyphens in compound numbers (e.g. \"Twenty-Five\" ā \"Twenty Five\"). | \r\n\r\n false: \"Twenty-Five\" \r\n true: \"Twenty Five\"\r\n | \r\n
titleCase | \r\n boolean | \r\nfalse | \r\nOutput words in Title Case, capitalizing hyphenated parts as well. | \r\n\r\n false: \"Twenty-five\" \r\n true: \"Twenty-Five\"\r\n | \r\n
noDefaultAnd | \r\n boolean | false | \r\nRemove default \"and\" before decimal points and currency minor units | \r\n \r\n false: \"One Hundred and Point Five\" / \"Dollars and Fifty Cents\" \r\n true: \"One Hundred Point Five\" / \"Dollars Fifty Cents\" \r\n | \r\n
// Input number: 125.55\r\n\r\n// Default\r\ntoWords(125.55);\r\n// Output: \"One Hundred Twenty Five and Point Five Five\"\r\n\r\n// noComa: true\r\ntoWords(125.55, { noComa: true });\r\n// Output: \"One Hundred Twenty Five and Point Five Five\" (no commas)\r\n\r\n// isAnd: true\r\ntoWords(125.55, { isAnd: true });\r\n// Output: \"One Hundred and Twenty Five and Point Five Five\"\r\n\r\n// noHypen: true\r\ntoWords(125.55, { noHypen: true });\r\n// Output: \"One Hundred Twenty Five and Point Five Five\" (no hyphen in \"Twenty Five\")\r\n\r\n// titleCase: true\r\ntoWords(125.55, { titleCase: true });\r\n// Output: \"One Hundred Twenty-Five and Point Five Five\" (capitalized words)\r\nThis package supports 130+ countries using ISO 3166-1 alpha-2 codes.
\r\n| Country | \r\nCode | \r\nCountry | \r\nCode | \r\nCountry | \r\nCode | \r\n
|---|---|---|---|---|---|
| Afghanistan | AF | Albania | AL | Algeria | DZ |
| Angola | AO | Argentina | AR | Armenia | AM |
| Australia | AU | Austria | AT | Azerbaijan | AZ |
| Bahrain | BH | Bangladesh | BD | Belarus | BY |
| Belgium | BE | Benin | BJ | Bolivia | BO |
| Bosnia and Herzegovina | BA | Brazil | BR | Bulgaria | BG |
| Burkina Faso | BF | Cambodia | KH | Cameroon | CM |
| Canada | CA | Chile | CL | China | CN |
| Colombia | CO | Costa Rica | CR | Croatia | HR |
| Cuba | CU | Czech Republic | CZ | DR Congo | CD |
| Denmark | DK | Ecuador | EC | Egypt | EG |
| El Salvador | SV | Estonia | EE | Ethiopia | ET |
| Finland | FI | France | FR | Gabon | GA |
| Georgia | GE | Germany | DE | Ghana | GH |
| Greece | GR | Guatemala | GT | Guinea | GN |
| Haiti | HT | Honduras | HN | Hong Kong | HK |
| Hungary | HU | India | IN | Indonesia | ID |
| Iran | IR | Iraq | IQ | Ireland | IE |
| Israel | IL | Italy | IT | Ivory Coast | CI |
| Japan | JP | Jordan | JO | Kazakhstan | KZ |
| Kenya | KE | Kuwait | KW | Kyrgyzstan | KG |
| Laos | LA | Latvia | LV | Lebanon | LB |
| Libya | LY | Lithuania | LT | Madagascar | MG |
| Malawi | MW | Malaysia | MY | Mali | ML |
| Mexico | MX | Moldova | MD | Morocco | MA |
| Mozambique | MZ | Myanmar | MM | Namibia | NA |
| Nepal | NP | Netherlands | NL | New Zealand | NZ |
| Nicaragua | NI | Niger | NE | Nigeria | NG |
| North Macedonia | MK | Norway | NO | Oman | OM |
| Pakistan | PK | Palestine | PS | Panama | PA |
| Paraguay | PY | Peru | PE | Philippines | PH |
| Poland | PL | Portugal | PT | Qatar | QA |
| Romania | RO | Russia | RU | Rwanda | RW |
| Saudi Arabia | SA | Senegal | SN | Serbia | RS |
| Sierra Leone | SL | Singapore | SG | Slovakia | SK |
| Slovenia | SI | South Africa | ZA | South Korea | KR |
| South Sudan | SS | Spain | ES | Sri Lanka | LK |
| Sudan | SD | Sweden | SE | Switzerland | CH |
| Syria | SY | Tajikistan | TJ | Taiwan | TW |
| Tanzania | TZ | Thailand | TH | Tunisia | TN |
| Turkey | TR | Turkmenistan | TM | Uganda | UG |
| Ukraine | UA | United Arab Emirates | AE | United Kingdom | GB |
| United States | US | Uruguay | UY | Uzbekistan | UZ |
| Venezuela | VE | Vietnam | VN | Yemen | YE |
| Zambia | ZM | Zimbabwe | ZW |
This package includes full TypeScript type definitions:
\r\nimport { toWords, toCurrencyWords, CountryCode } from 'number-to-words';\r\n\r\nconst amount: string = toCurrencyWords(123.45, 'US' as CountryCode);\r\nThis library is fully compatible with:
\r\nContributions are welcome! Please:
\r\nSee LICENSE for full details.
\r\n","readmeFilename":"README.md"}