Function forEach

  • Iterates over elements of collection and invokes iteratee for each element. The iteratee is invoked with three arguments: (value, index|key, collection). Iteratee functions may exit iteration early by explicitly returning false.

    Note: As with other "Collections" methods, objects with a "length" property are iterated like arrays. To avoid this behavior use forIn or forOwn for object iteration.

    Type Parameters

    • T

    Parameters

    • Optional collection: ArrayLike<T>

      The collection to iterate over.

      Optional
    • Optional iteratee: ArrayIteratee<T, void>

      The function invoked per iteration.

      Optional

    Returns void

    Returns collection.

    Since

    5.0.0

    Alias

    each

    See

    [[forEachRight]],[[forIn]],[[forInRight]],[[forOwn]],[[forOwnRight]]

    Example

    forEach([1, 2], value => console.log(value))
    // => Logs `1` then `2`.

    forEach({ 'a': 1, 'b': 2 }, (value, key) => console.log(key))
    // => Logs 'a' then 'b' (iteration order is not guaranteed).
  • Type Parameters

    • T

    Parameters

    • Optional collection: PlainObject<T>
      Optional
    • Optional iteratee: RecordIteratee<T, void>
      Optional

    Returns void