num-format ·  !Version 0.1.0   !PRs Welcome

Number pretty printer for currency, percents, and adding thousands separators.

FormatCurrency

$3

- number: Number - Value to convert
- roundToInteger: Boolean - Defaults to true (Optional)
- locale: String - Defaults to 'en-US' (Optional)
- currency: String - Defaults to 'USD' (Optional)

$3

``javascript
// Pretty Print: Currency (w/ Cents - Trailing 0s)
>> FormatCurrency(123456, false); // '$123,456.00'

// Pretty Print: Currency (w/ Cents)
>> FormatCurrency(123456.78, false); // '$123,456.78'


// Pretty Print: Currency (Rounded)
>> FormatCurrency(9876.54); // '$9,877'


// Pretty Print: Currency (Locale Override - United Kingdom - Integer)
>> FormatCurrency(123456.78, true, 'en-GB', 'GBP'); // '£123,457'

`

FormatNumber

$3

- number: Number - Value to convert
- precision: Number - Defaults to 2 (Optional)
- locale: String - Defaults to 'en-US' (Optional)

$3

`javascript
// Pretty Print: Number (2 places)'
>> FormatNumber(1000); // '1,000'


// Pretty Print: Number (1 place)'
>> FormatNumber(1234567.89, 1); // '1,234,567.9'


// Pretty Print: Number (0 places - Round)'
>> FormatNumber(22333.44, 0); // '22,333'
`

FormatPercent

$3

- number: Number - Value to convert
- precision: Number - Defaults to 2 (Optional)
- locale: String - Defaults to 'en-US' (Optional)

$3

`javascript
// Pretty Print: Percentage (2 places)'
>> FormatPercent(0.8522); // '85.22%'


// Pretty Print: Percentage (Trailing 0)'
>> FormatPercent(0.135); // '13.50%'


// Pretty Print: Percentage (1 place)'
>> FormatPercent(0.7337, 1); // '73.4%'


// Pretty Print: Percentage (0 places - Round Up)'
>> FormatPercent(0.5567, 0); // '56%'


// Pretty Print: Percentage (0 places - Round Down)
>> FormatPercent(0.3312, 0); // '33%'
`

Locale Support:

In the current version of num-format it should be assumed that only en-US` formatting is supported as Node 8.x has limited locale support.

---
###### num-format uses Semantic Versioning. | Copyright © 2018 Chris Kilpatrick. Released under MIT License.