➕ Calculates the sum of all numbers in an array.

Syntax

TypeScript
import { sum } from '@opentf/std';

sum<T>(
  arr: T[] = [],
  cb?: (val: T, index: number) => number
): number

Parameters

  • arr: An array of numbers.

  • cb: An optional iteratee invoked for each element to generate the value to be summed.

Returns

The sum of all elements. Returns 0 for empty arrays.

Examples

TypeScript
sum([]) //=> 0

sum([1]) //=> 1

sum([1, -1]) //=> 0

sum([-1, -2]) //=> -3

sum([1, 2, 3, 4, 5]) //=> 15

sum([1, 2, 3, 4, 5.4], Math.round) //=> 15

const objects = [{ n: 4 }, { n: 2 }, { n: 8 }];
sum(objects, (v) => v.n) //=> 14

sum(objects, (v, i) => v.n * i) //=> 18 ( (4*0) + (2*1) + (8*2) = 18 )
Last updated on
Edit this page