docs/reference/compat/math/sum.md
::: warning Use sum from es-toolkit
This sum function works slowly due to type conversion and null/undefined handling.
Use the faster and more modern sum from es-toolkit instead.
:::
Adds all values in an array.
const total = sum(array);
sum(array)Adds all numbers in an array to get the total sum.
import { sum } from 'es-toolkit/compat';
// Number array
sum([1, 2, 3]);
// Returns: 6
sum([1.5, 2.5, 3]);
// Returns: 7
// Empty array
sum([]);
// Returns: 0
Handles BigInt and strings as well.
import { sum } from 'es-toolkit/compat';
// BigInt array
sum([1n, 2n, 3n]);
// Returns: 6n
// String array (concatenated)
sum(['1', '2']);
// Returns: '12'
Invalid values are ignored.
import { sum } from 'es-toolkit/compat';
sum([1, undefined, 2]);
// Returns: 3 (undefined ignored)
sum(null);
// Returns: 0
sum(undefined);
// Returns: 0
array (ArrayLike<any> | null | undefined): The array containing values to add.(number): Returns the total sum of all values.