es-toolkit/dist/bigint/maxBy.d.mts

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

//#region src/bigint/maxBy.d.ts
/**
 * Finds the element in an array that has the largest bigint value returned by `getValue`.
 *
 * This function maps every element to a bigint and returns the element with the largest value.
 * If several elements tie, the first one is returned.
 *
 * @template T - The type of elements in the array.
 * @param items - An array of elements to search.
 * @param getValue - A function that maps an element to the bigint to compare by.
 * @returns The element with the largest mapped bigint.
 * @throws {RangeError} If the array is empty, since there is no element to return.
 *
 * @example
 * const accounts = [{ balance: 10n }, { balance: 30n }, { balance: 20n }];
 * const result = maxBy(accounts, account => account.balance);
 * // result will be { balance: 30n }
 */
declare function maxBy<T>(items: readonly T[], getValue: (element: T, index: number, array: readonly T[]) => bigint): T;
//#endregion
export { maxBy };