Documentation / @ripl/utilities / numberRoundTo

Function: numberRoundTo()

numberRoundTo(value, precision?): number

Defined in: packages/utilities/src/number.ts:99

Rounds a number to at most precision decimal places, stripping any trailing zeros.

Unlike Number.prototype.toFixed (which returns a fixed-width string), this returns a number so integers stay integers (numberRoundTo(5, 2) === 5) and fractional values are capped (numberRoundTo(1.005, 2) === 1.01, numberRoundTo(3.14159, 2) === 3.14). Non-finite values pass through unchanged. Used as the default precision cap for chart labels, axes, and tooltips.

Parameters

Parameter	Type	Default value
value	number	undefined
precision	number	2

Returns

number