https://github.com/alibasiccoder/convert-to-words

A small library to convert number to words (like 10 to ten)
https://github.com/alibasiccoder/convert-to-words

english numbers spanish

Last synced: 21 days ago
JSON representation

A small library to convert number to words (like 10 to ten)

• Host: GitHub
• URL: https://github.com/alibasiccoder/convert-to-words
• Owner: AliBasicCoder
• License: mit
• Created: 2019-05-25T04:18:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-23T02:35:18.000Z (over 4 years ago)
• Last Synced: 2024-12-28T20:07:33.799Z (about 2 months ago)
• Topics: english, numbers, spanish
• Language: TypeScript
• Homepage:
• Size: 160 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# convert-to-words

[![npm](https://img.shields.io/npm/v/convert-to-words.svg)](https://www.npmjs.com/package/convert-to-words)

[![GitHub](https://img.shields.io/github/license/AliBasicCoder/convert-to-words.svg)](https://github.com/AliBasicCoder/convert-to-words/)

[![npm bundle size](https://img.shields.io/bundlephobia/min/convert-to-words.svg?style=plastic)](https://bundlephobia.com/result?p=convert-to-words@latest)

[![npm](https://img.shields.io/npm/dm/convert-to-words.svg)](https://www.npmjs.com/package/convert-to-words)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FAliBasicCoder%2Fconvert-to-words.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2FAliBasicCoder%2Fconvert-to-words?ref=badge_small)

[convert-to-words](https://github.com/AliBasicCoder/convert-to-words/) is a small javaScript TypeScript lib helps you to convert any number up

to 10^300 and also covers decimal numbers and

if its in the numbers you want to convert ar in dome txt you don't

want to change it will do that for you be default 

# installation

## npm

```shell

npm i convert-to-words

```

## cdn

```

https://cdn.jsdelivr.net/npm/[email protected]/index.js

```

# options:

| option      |                                                           description | default |

| ----------- | --------------------------------------------------------------------: | ------: |

| lang        | changes the lang the supported languages is English:'en' Spanish:'es' |      en |

| numbersOnly |       when it set to true it makes the functions receive numbers only |   false |

## Usage:

```js

// this will run on both browser and node

const convertToWords = convertToWords || require('convert-to-words');

convertToWords(999.999, {lang:'es'}); // => novecientos noveta y nueve comma novecientos noveta y nueve

```

also you can change the default of the function

```js

// changing the default lang

convertToWords.options.lang = 'es';

// making the function receive numbers only (number could be also pass in as string)

// NOTE: it will throw an error if receives any thing except numbers

convertToWords.options.numberOnly = true;

convertToWords('999.99') // => novecientos noveta y nueve comma novecientos noveta y nueve

```

# LICENCE

MIT License

Copyright (c) 2019 AliBasicCoder