es-toolkit/dist/math/round.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/math/round.ts
/**
* Rounds a number to a specified precision.
*
* This function takes a number and an optional precision value, and returns the number rounded
* to the specified number of decimal places.
*
* @param value - The number to round.
* @param [precision=0] - The number of decimal places to round to. Defaults to 0.
* @returns The rounded number.
* @throws {Error} Throws an error if `Precision` is not integer.
*
* @example
* const result1 = round(1.2345); // result1 will be 1
* const result2 = round(1.2345, 2); // result2 will be 1.23
* const result3 = round(1.2345, 3); // result3 will be 1.235
* const result4 = round(1.2345, 3.1); // This will throw an error
*/
function round(value, precision = 0) {
	if (!Number.isInteger(precision)) throw new Error("Precision must be an integer.");
	const multiplier = Math.pow(10, precision);
	return Math.round(value * multiplier) / multiplier;
}
//#endregion
export { round };