format-currency
format-currency
is a JavaScript component to format numbers and strings to currency strings. Used in Exodus Ethereum Wallet.
Install
npm install --save format-currency
Notes
- Must have a JavaScript environment with
Object.assign
and Intl.NumberFormat
.
In Node.js, this is at least v4. You can install in older environments, you'll just
need to polyfill.
Usage
formatCurrency
Signature: formatCurrency(value, [options])
Parameters:
value
: Value to convert. Will pass through parse-num first.
Will coerce anything to a number.options
: optional object
parameter to specify options.
Appending Digits
is not necessary. You can also shorten maximum
to max
and minimum
to min
. Adds one more option nanZero
, which when the number is
NaN
, if it should be coerced to 0
- defaults to true
i.e. NaN => '0'
. Also available code
, symbol
, format
.
Returns:
A string
currency representation of the number.
Example:
const formatCurrency = require('format-currency')
console.log(formatCurrency(10000000.15))
let opts = { format: '%v %c', code: 'USD' }
console.log(formatCurrency(10000000.15, opts))
let opts = { format: '%s%v %c', code: 'USD', symbol: '$' }
console.log(formatCurrency(10000000.15, opts))
let opts = { format: '%s%v', symbol: '$' }
console.log(formatCurrency('$10,000,000.15 USD', opts))
let opts = { format: '%s%v', symbol: '$', locale: 'de-DE' }
console.log(formatCurrency(10000000.15, opts))
console.log(formatCurrency(10000000.15, opts))
let opts = { format: '%v %c', code: 'BTC', maxFraction: 8 }
console.log(formatCurrency(1.123456789, opts))
Related
- format-num: Format numbers / number strings to nice strings with grouping and decimal separators.
- number-unit: Numbers with units. Easily convert numbers to from different units.
- parse-num: Parse anything into a number. A dependency
of this library.
License
MIT