JSPM

format-num

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4476
  • Score
    100M100P100Q127350F
  • License MIT

Format numbers.

Package Exports

  • format-num
  • format-num/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (format-num) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

format-num

NPM Package Build Status js-standard-style

format-num is a JavaScript component to format numbers to strings. Used in Exodus Ethereum Wallet.

Install

npm install --save format-num

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

formatNum

Signature: formatNum(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'.

Returns:

The string representation of the number.

Example:

const formatNum = require('format-num')

console.log(formatNum(10000000.15)) // => 10,000,000.15
console.log(formatNum('10000000.15')) // => 10,000,000.15

console.log(formatNum(0.0000000000044535, { maxSignificant: 2 })) // => 0.0000000000045
console.log(formatNum(0, { minFraction: 2, maxFraction: 2 }))  // => 0.00

console.log(formatNum(null)) // => 0
console.log(formatNum(null, { nanZero: false })) // => NaN
  • parse-num: Parse anything into a number. A dependency of this library.
  • number-unit: Numbers with units. Easily convert numbers to from different units.

License

MIT