Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Predicate<TThis, TObject>

A method which is used to determine whether a value within a collection meets a set of criteria.

Type parameters

  • TThis

  • TObject

Hierarchy

  • Predicate

Callable

  • __call(this: TThis, object: TObject, key?: undefined | string): boolean
  • A function which is called to determine whether a value meets arbitrary criteria

    Parameters

    • this: TThis
    • object: TObject

      The value of the item in the collection

    • Optional key: undefined | string

      The key, if one is available, under which the item appeared within the collection

    Returns boolean

    A true-y value if the item met the predicate conditions, false-y values if it did not.

Generated using TypeDoc