Skip to main content

reduce

_.reduce(iteratee, accumulator, collection) # Ⓢ [Ⓣ][1] Ⓝ

Reduces collection to a value which is the accumulated result of running



each element in collection thru iteratee, where each successive



invocation is supplied the return value of the previous. If accumulator



is not given, the first element of collection is used as the initial



value. The iteratee is invoked with four arguments:



(accumulator, value, index|key, collection).





Many lodash methods are guarded to work as iteratees for methods like



_.reduce, _.reduceRight, and _.transform.





The guarded methods are:



assign, defaults, defaultsDeep, includes, merge, orderBy,



and sortBy

Since​

0.1.0

Arguments​

  1. iteratee (Function): The function invoked per iteration.
  2. accumulator (*): The initial value.
  3. collection (Array|Object): The collection to iterate over.

Returns​

(*): Returns the accumulated value.

Example​

_.reduce(
  function (sum, n) {
    return sum + n;
  },
  0,
  [1, 2]
);
// => 3