{"_id":"format-num","_rev":"409716","name":"format-num","description":"Format numbers.","dist-tags":{"latest":"1.0.0"},"maintainers":[{"name":"jprichardson","email":""}],"time":{"modified":"2021-08-04T05:03:48.000Z","created":"2016-03-17T15:25:17.268Z","1.0.0":"2016-03-17T15:25:17.268Z"},"users":{"rocket0191":true},"author":{"name":"JP Richardson"},"repository":{"type":"git","url":"git+https://github.com/exodusmovement/format-num.git"},"versions":{"1.0.0":{"name":"format-num","version":"1.0.0","description":"Format numbers.","main":"index.js","files":["index.js"],"scripts":{"lint":"standard","test":"npm run lint && npm run unit","unit":"ava --verbose"},"repository":{"type":"git","url":"git+https://github.com/exodusmovement/format-num.git"},"keywords":["number","format","formatting","string","number-unit"],"author":{"name":"JP Richardson"},"license":"MIT","bugs":{"url":"https://github.com/exodusmovement/format-num/issues"},"homepage":"https://github.com/exodusmovement/format-num#readme","dependencies":{"parse-num":"^1.0.0"},"devDependendies":{"standard":"5.x"},"gitHead":"b9447bae30e736a4ae65409052bdc5af0172d4ee","_id":"format-num@1.0.0","_shasum":"a0314cc47301212a061e76cf15ead8e614207077","_from":".","_npmVersion":"3.7.1","_nodeVersion":"5.3.0","_npmUser":{"name":"jprichardson","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jprichardson","email":""}],"dist":{"shasum":"a0314cc47301212a061e76cf15ead8e614207077","size":2046,"noattachment":false,"key":"/format-num/-/format-num-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/format-num/download/format-num-1.0.0.tgz"},"_npmOperationalInternal":{"host":"packages-13-west.internal.npmjs.com","tmp":"tmp/format-num-1.0.0.tgz_1458228314898_0.10390877048484981"},"directories":{},"publish_time":1458228317268,"_cnpm_publish_time":1458228317268,"_hasShrinkwrap":false}},"readme":"format-num\n==========\n\n[![NPM Package](https://img.shields.io/npm/v/format-num.svg?style=flat-square)](https://www.npmjs.org/package/format-num)\n[![Build Status](https://img.shields.io/travis/ExodusMovement/format-num.svg?branch=master&style=flat-square)](https://travis-ci.org/ExodusMovement/format-num)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)\n\n`format-num` is a JavaScript component to format numbers to strings. Used in [Exodus Ethereum Wallet](http://www.exodus.io/).\n\n\nInstall\n-------\n\n    npm install --save `format-num`\n\n\nNotes\n-----\n\n- Must have a JavaScript environment with `Object.assign` and `Intl.NumberFormat`.\nIn Node.js, this is at least v4. You can install in older environments, you'll just\nneed to polyfill.\n\n\nUsage\n-----\n\n### formatNum\n\n**Signature:** `formatNum(value, [options])`\n\n**Parameters:**\n\n- `value`: Value to convert. Will pass through [parse-num](https://github.com/ExodusMovement/parse-num) first.\nWill coerce anything to a number.\n- `options`: *optional* `object` parameter to specify [options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat).\nAppending `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\n`NaN`, if it should be coerced to `0` - defaults to `true` i.e. `NaN => '0'`.\n\n\n**Returns:**\n\nThe `string` representation of the number.\n\n**Example:**\n\n```js\nconst formatNum = require('format-num')\n\nconsole.log(formatNum(10000000.15)) // => 10,000,000.15\nconsole.log(formatNum('10000000.15')) // => 10,000,000.15\n\nconsole.log(formatNum(0.0000000000044535, { maxSignificant: 2 })) // => 0.0000000000045\nconsole.log(formatNum(0, { minFraction: 2, maxFraction: 2 }))  // => 0.00\n\nconsole.log(formatNum(null)) // => 0\nconsole.log(formatNum(null, { nanZero: false })) // => NaN\n```\n\n\nRelated\n-------\n\n- [parse-num](https://github.com/ExodusMovement/parse-num): Parse anything into a number. A dependency\nof this library.\n\n\nLicense\n-------\n\nMIT\n","_attachments":{},"homepage":"https://github.com/exodusmovement/format-num#readme","bugs":{"url":"https://github.com/exodusmovement/format-num/issues"},"license":"MIT"}