Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.51 KB

README.md

File metadata and controls

54 lines (40 loc) · 1.51 KB

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)

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)
      • false / 0: default value without k (1200)

return

default return value is string