@kitiumai/utils-ts/dist/runtime/number.d.ts

Comprehensive TypeScript utilities for KitiumAI projects

/**
 * Number utility functions
 */
/**
 * Clamp a number between min and max values
 *
 * @param value - The number to clamp
 * @param min - Minimum value
 * @param max - Maximum value
 * @returns The clamped value
 *
 * @example
 * ```ts
 * clamp(15, 0, 10) // 10
 * clamp(-5, 0, 10) // 0
 * clamp(5, 0, 10) // 5
 * ```
 */
export declare function clamp(value: number, min: number, max: number): number;
/**
 * Generate a random number between min (inclusive) and max (exclusive)
 *
 * @param min - Minimum value (inclusive)
 * @param max - Maximum value (exclusive)
 * @returns A random number
 *
 * @example
 * ```ts
 * random(0, 10) // A number between 0 and 10
 * ```
 */
export declare function random(min: number, max: number): number;
/**
 * Generate a random integer between min (inclusive) and max (inclusive)
 *
 * @param min - Minimum value (inclusive)
 * @param max - Maximum value (inclusive)
 * @returns A random integer
 *
 * @example
 * ```ts
 * randomInt(0, 10) // An integer between 0 and 10
 * ```
 */
export declare function randomInt(min: number, max: number): number;
/**
 * Check if a number is within a range
 *
 * @param value - The number to check
 * @param start - Start of range (or end if end is not provided)
 * @param end - End of range (optional)
 * @returns True if value is in range
 *
 * @example
 * ```ts
 * inRange(5, 0, 10) // true
 * inRange(15, 0, 10) // false
 * inRange(3, 5) // true (checks if 3 is in [0, 5))
 * ```
 */
export declare function inRange(value: number, start: number, end?: number): boolean;
/**
 * Calculate the sum of numbers
 *
 * @param numbers - Array of numbers to sum
 * @returns The sum of all numbers
 *
 * @example
 * ```ts
 * sum([1, 2, 3, 4]) // 10
 * ```
 */
export declare function sum(numbers: number[]): number;
/**
 * Calculate the mean (average) of numbers
 *
 * @param numbers - Array of numbers
 * @returns The mean, or NaN if array is empty
 *
 * @example
 * ```ts
 * mean([1, 2, 3, 4]) // 2.5
 * mean([]) // NaN
 * ```
 */
export declare function mean(numbers: number[]): number;
/**
 * Find the minimum value in an array
 *
 * @param numbers - Array of numbers
 * @returns The minimum value, or undefined if array is empty
 *
 * @example
 * ```ts
 * min([1, 5, 3, 2]) // 1
 * min([]) // undefined
 * ```
 */
export declare function min(numbers: number[]): number | undefined;
/**
 * Find the maximum value in an array
 *
 * @param numbers - Array of numbers
 * @returns The maximum value, or undefined if array is empty
 *
 * @example
 * ```ts
 * max([1, 5, 3, 2]) // 5
 * max([]) // undefined
 * ```
 */
export declare function max(numbers: number[]): number | undefined;
/**
 * Find the item with the minimum value according to a function
 *
 * @template T - The type of array elements
 * @param array - Array of items
 * @param fn - Function that returns a number for each item
 * @returns The item with minimum value, or undefined if array is empty
 *
 * @example
 * ```ts
 * minBy([{ age: 20 }, { age: 30 }], x => x.age) // { age: 20 }
 * ```
 */
export declare function minBy<T>(array: T[], fn: (item: T) => number): T | undefined;
/**
 * Find the item with the maximum value according to a function
 *
 * @template T - The type of array elements
 * @param array - Array of items
 * @param fn - Function that returns a number for each item
 * @returns The item with maximum value, or undefined if array is empty
 *
 * @example
 * ```ts
 * maxBy([{ age: 20 }, { age: 30 }], x => x.age) // { age: 30 }
 * ```
 */
export declare function maxBy<T>(array: T[], fn: (item: T) => number): T | undefined;
//# sourceMappingURL=number.d.ts.map