topkat-utils/dist/src/math-utils.d.ts

A comprehensive collection of TypeScript/JavaScript utility functions for common programming tasks. Includes validation, object manipulation, date handling, string formatting, and more. Zero dependencies, fully typed, and optimized for performance.

/** Round with custom number of decimals (default:0) */
export declare function round(number: number | string, decimals?: number): number;
/** Round with custom number of decimals (default:2) */
export declare function round2<T extends 'number' | 'string' = 'string'>(number: number | string, decimals?: number, format?: T): T extends "number" ? number : string;
/** Is number between two numbers (including those numbers) */
export declare function isBetween(number: number, min: number, max: number, inclusive?: boolean): boolean;
/** Random number between two values with 0 decimals by default */
export declare function random(nb1: number, nb2: number, nbOfDecimals?: number): number;
/** Random multiple of a number between two values */
export declare function randomMultipleOf(multiple: number, nb1: number, nb2: number): number;
/** Sum all values of an array, all values MUST be numbers */
export declare function sumArray(array: number[]): number;
/** Moyenne / average between array of values
 * @param {Number} round number of decimals to keep. Default:2
*/
export declare function moyenne(array: number[], nbOfDecimals?: number): number;
/** length default 2, shortcut for 1 to 01 */
export declare function pad(numberOrStr: number | string, length?: number): string;
/** return the number or the closest number of the range
 * * nb min max  => returns
 * * 7  5   10   => 7 // in the range
 * * 2  5   10   => 5 // below the min value
 * * 99 5   10   => 10// above the max value
 */
export declare function minMax(nb: number, min: number, max: number): number;