es-toolkit/dist/bigint/min.d.ts

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

//#region src/bigint/min.d.ts
/**
 * Finds the smallest bigint in an array.
 *
 * This function iterates through the array and returns the smallest element. Unlike `Math.min`,
 * which cannot accept bigints, it compares values directly so arbitrarily large integers stay exact.
 *
 * @param nums - An array of bigints to search.
 * @returns The smallest bigint in the array.
 * @throws {RangeError} If the array is empty, since there is no bigint that represents "no minimum".
 *
 * @example
 * const result = min([1n, 5n, 3n]);
 * // result will be 1n
 */
declare function min(nums: readonly bigint[]): bigint;
//#endregion
export { min };