LendAndRegret/node_modules/es-toolkit/dist/compat/math/sum.d.mts
2026-05-02 17:27:43 +08:00

20 lines
532 B
TypeScript

/**
* Computes the sum of the values that are returned by the `iteratee` function.
*
* It does not coerce values to `number`.
*
* @param {ArrayLike<any> | null | undefined} array - The array to iterate over.
* @returns {number} Returns the sum.
*
* @example
* sum([1, 2, 3]); // => 6
* sum([1n, 2n, 3n]); // => 6n
* sum(["1", "2"]); // => "12"
* sum([1, undefined, 2]); // => 3
* sum(null); // => 0
* sum(undefined); // => 0
*/
declare function sum(array: ArrayLike<any> | null | undefined): number;
export { sum };