Options
All
  • Public
  • Public/Protected
  • All
Menu

Module forEach

Index

References

Functions Collection

References

Renames and re-exports forEach

Collection Functions

  • forEach<T>(collection?: ArrayLike<T>, iteratee?: ArrayIteratee<T, void>): void
  • forEach<T>(collection?: PlainObject<T>, iteratee?: RecordIteratee<T, void>): void
  • 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.

    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: ArrayLike<T>

      The collection to iterate over.

    • Optional iteratee: ArrayIteratee<T, void>

      The function invoked per iteration.

    Returns void

    Returns collection.

  • Type parameters

    • T

    Parameters

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

    Returns void