Function find

  • Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

    Type Parameters

    • T

    • S

    Parameters

    • collection: undefined | null | List<T>

      The collection to search.

    • predicate: ListIteratorTypeGuard<T, S>

      The function invoked per iteration.

    • Optional fromIndex: number

      The index to search from.

    Returns undefined | S

    Returns the matched element, else undefined.

  • See

    _.find

    Type Parameters

    • T

    Parameters

    • collection: undefined | null | List<T>
    • Optional predicate: ListIterateeCustom<T, boolean>
    • Optional fromIndex: number

    Returns undefined | T

  • See

    _.find

    Type Parameters

    • T extends object

    • S

    Parameters

    • collection: undefined | null | T
    • predicate: ObjectIteratorTypeGuard<T, S>
    • Optional fromIndex: number

    Returns undefined | S

  • See

    _.find

    Type Parameters

    • T extends object

    Parameters

    • collection: undefined | null | T
    • Optional predicate: ObjectIterateeCustom<T, boolean>
    • Optional fromIndex: number

    Returns undefined | T[keyof T]

Settings

Member Visibility

Theme

Generated using TypeDoc