@devlander/utils
Version:
Comprehensive JavaScript and TypeScript utilities for seamless development. Includes object manipulation, data validation, and more.
17 lines (16 loc) • 507 B
TypeScript
/**
* Rounds a number to a specified number of decimal places.
*
* @param num - The number to round.
* @param decimals - The number of decimal places to round to. Defaults to 0.
* @returns The rounded number.
*
* @example
* ```typescript
* roundToDecimal(3.14159, 2); // Returns: 3.14
* roundToDecimal(3.14159, 0); // Returns: 3
* roundToDecimal(3.5); // Returns: 4
* roundToDecimal(3.4); // Returns: 3
* ```
*/
export declare const roundToDecimal: (num: number, decimals?: number) => number;