Numeral

Numeral is a standard Deno module for formatting and manipulating numbers.

🔧 How to use

import { numeral } from 'https://deno.land/x/numeral@v0.1.0/mod.ts';

💡 Usage

🎀 Create

Create an instance of a numeral. Numeral takes numbers or strings that it trys to convert into a number.

const myNumeral = numeral(1000);

const value = myNumeral.value();
// 1000

const myNumeral2 = numeral('1,000');

const value2 = myNumeral2.value();
// 1000

🎀 Format

Numbers can be formatted to look like currency, percentages, times, or even plain old numbers with decimal places, thousands, and abbreviations.

const string = numeral(1000).format('0,0');
// '1,000'

Numbers

Currency

Bytes

Percentages

Time

Exponential

🎀 Functions

Value

The value is always available.

const number = numeral(1000);

const string = number.format('0,0');
// '1,000'

const value = number.value();
// 1000

Manipulate

Not that you will use these often, but they're there when you need them.

const number = numeral(1000);

const added = number.add(10);
// 1010

Set

Set the value of your numeral object.

const number = numeral();

number.set(1000);

const value = number.value();
// 1000

Difference

Find the difference between your numeral object and a value

const number = numeral(1000),
      value = 100;

const difference = number.difference(value);
// 900

Clone

Go ahead and clone any numeral object while you're at it.

const a = numeral(1000);
const b = numeral(a);
const c = a.clone();

const aVal = a.set(2000).value();
// 2000

const bVal = b.value();
// 1000

const cVal = c.add(10).value();
// 1010

🎀 Settings

Default Formatting

Set a default format so you can use .format() without a string. The default format to '0,0'

const number = numeral(1000);

number.format();
// '1,000'

numeral.defaultFormat('$0,0.00');

number.format();
// '$1,000.00'

Custom Zero and Null Formatting

Set a custom output when formatting numerals with a value of 0 or null

const number = numeral(0);
const nullNumber = numeral(null);

numeral.zeroFormat('N/A');
numeral.nullFormat('N/A');

const zero = number.format('0.0')
// 'N/A'

const na = nullNumber.format('0.0')
// 'N/A'

❗ Issues

If you think any of the Numeral can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.

💪 Contribution

We'd love to have your helping hand on contributions to Numeral by forking and sending a pull request!

Your contributions are heartily ♡ welcome, recognized and appreciated. (✿◠‿◠)

How to contribute:

• Open pull request with improvements
• Discuss ideas in issues
• Spread the word
• Reach out with any feedback

⚖️ License

The MIT License