toprecision
v1.4.1
Published
[toPrecision](https://www.npmjs.com/package/toprecision) is a npm module similar to built-in [.toPrecision()](https://www.w3schools.com/jsref/jsref_toprecision.asp), but without exponential notation.
Downloads
47
Maintainers
Readme
About
toPrecision is a npm module similar to built-in .toPrecision(), but without exponential notation.
toPrecision() VS default .toPrecision():
- without exponential notation (eg 1.23e4)
- Both numbers in string ('123') and numbers (123) are supported.
- optional thousand separator (1,200)
- optional currency symbol ($200)
eg
const pc = require('toprecision')
let v = 12345.678
t = pc(v, 4) // t:12350
t = pc(v, 4, {comma:1}) t:'12,350'
t = pc(v, 4, {k:1}) t:'12.35k'
t = pc(v, 4, {dollar:1}) t:'$12350'
t = pc(v, 4, {prefix:'USD'}) t:'USD12350'
eg2 (ceil, floor, round)
let v = 12345.678
t = pc(v, 4) // t: 12350 // default round
t = pc(v, 4, {type:'ceil'}) // t: 12350
t = pc(v, 4, {ceil:1}) // t: 12350
t = pc(v, 4, {type:'floor'}) // t: 12340
t = pc(v, 4, {floor:1}) // t: 12340
Installation
In terminal (navigate to your project folder first):
npm i toprecision
then in your .js file, include this code to start using:
import toPrecision from "toprecision"
console.log(toPrecision(0.01234, 3)) // output: 0.0123
Parameters
function toPrecision(val, prec, { comma, dollar, prefix })
- value = any number
- precision = integer (1-100)
- if omitted, toPrecision will return back the value
- if value is outisde 1-100, error will be emitted
- optional
- comma/c = bool (true, 1 / false, 0)
- true / 1: will return string: 1,200
- false / 0: default value, will return number without separator
- dollar/d = bool (true, 1 / false, 0)
- true / 1: return dollar sign ($200)
- false / 0: default value without dollar sign (200)
- prefix/pre/p = string
- eg: € => €200, $ => $200, USD => USD200
- default value: '' (empty_string)
- k = bool (true, 1 / false, 0)
- true / 1: return with k behind if value >= 1000 (1.2k)
- value >= 1,000,000 (1.2M); value >= 1,000,000,000 (1.2B)
- false / 0: default value without k (1200)
- true / 1: return with k behind if value >= 1000 (1.2k)
- type = 'ceil|floor' // default undefined
- ceil = 0|1 // default 0; shorthand for type='ceil'
- floor = 0|1 // default 0; shorthand for type='floor'
- comma/c = bool (true, 1 / false, 0)
return
default return value is string