Options
All
  • Public
  • Public/Protected
  • All
Menu

Module iterable/find

Index

References

Functions

References

Renames and re-exports find

Functions

  • find<T, R>(predicate: (t: T) => t is R, iterable: Iterable<T>): T
  • find<T>(predicate: (t: T) => boolean, iterable: Iterable<T>): T
  • find<T, R>(predicate: (t: T) => t is R): (iterable: Iterable<T>) => T
  • find<T>(predicate: (t: T) => boolean): (iterable: Iterable<T>) => T
  • Find element in iterable sort matched with predicate

    example
     find(n => n % 2 === 0, new Set([1, 2, 3, 4]));    //=> 2
    find(n => n > 100, new Set([1, 2, 3, 4])); //=> undefined

    Type parameters

    • T

    • R

    Parameters

    • predicate: (t: T) => t is R

      The predicate function

        • (t: T): t is R
        • Parameters

          • t: T

          Returns t is R

    • iterable: Iterable<T>

      The iterable target to find

    Returns T

  • Find element in iterable sort matched with predicate

    example
     find(n => n % 2 === 0, new Set([1, 2, 3, 4]));    //=> 2
    find(n => n > 100, new Set([1, 2, 3, 4])); //=> undefined

    Type parameters

    • T

    Parameters

    • predicate: (t: T) => boolean

      The predicate function

        • (t: T): boolean
        • Parameters

          • t: T

          Returns boolean

    • iterable: Iterable<T>

      The iterable target to find

    Returns T

  • Find element in iterable sort matched with predicate

    example
     find(n => n % 2 === 0, new Set([1, 2, 3, 4]));    //=> 2
    find(n => n > 100, new Set([1, 2, 3, 4])); //=> undefined

    Type parameters

    • T

    • R

    Parameters

    • predicate: (t: T) => t is R

      The predicate function

        • (t: T): t is R
        • Parameters

          • t: T

          Returns t is R

    Returns (iterable: Iterable<T>) => T

      • (iterable: Iterable<T>): T
      • Parameters

        • iterable: Iterable<T>

        Returns T

  • Find element in iterable sort matched with predicate

    example
     find(n => n % 2 === 0, new Set([1, 2, 3, 4]));    //=> 2
    find(n => n > 100, new Set([1, 2, 3, 4])); //=> undefined

    Type parameters

    • T

    Parameters

    • predicate: (t: T) => boolean

      The predicate function

        • (t: T): boolean
        • Parameters

          • t: T

          Returns boolean

    Returns (iterable: Iterable<T>) => T

      • (iterable: Iterable<T>): T
      • Parameters

        • iterable: Iterable<T>

        Returns T

Generated using TypeDoc