Class PredicateStatic

The Predicates class offers some helper functions to deal with Predicate including the ability to build Predicate from functions using PredicateStatic.of, some builtin predicates like PredicateStatic.isIn, and the ability to combine to combine Predicates like with PredicateStatic.allOf.

Hierarchy

PredicateStatic

Index

Methods

Methods

allOf

allOf<T>(...predicates: Array<function>): Predicate<T>

- Defined in Predicate.ts:107
Return a Predicate checking whether all of the predicate functions given hold

Type parameters
- T
Parameters
- Rest ...predicates: Array<function>
Returns Predicate<T>

anyOf

anyOf<T>(...predicates: Array<function>): Predicate<T>

- Defined in Predicate.ts:114
Return a Predicate checking whether any of the predicate functions given hold

Type parameters
- T
Parameters
- Rest ...predicates: Array<function>
Returns Predicate<T>

equals

equals<T>(other: T & WithEquality): Predicate<T & WithEquality>

- Defined in Predicate.ts:92
Return a Predicate checking whether a value is equal to the value you give as parameter.

Type parameters
- T
Parameters
- other: T & WithEquality
Returns Predicate<T & WithEquality>

isIn

isIn<T>(others: Iterable<T & WithEquality>): Predicate<T & WithEquality>

- Defined in Predicate.ts:100
Return a Predicate checking whether a value is contained in the list of values you give as parameter.

Type parameters
- T
Parameters
- others: Iterable<T & WithEquality>
Returns Predicate<T & WithEquality>

noneOf

noneOf<T>(...predicates: Array<function>): Predicate<T>

- Defined in Predicate.ts:121
Return a Predicate checking whether none of the predicate functions given hold

Type parameters
- T
Parameters
- Rest ...predicates: Array<function>
Returns Predicate<T>

of

of<T>(fn: function): Predicate<T>

- Defined in Predicate.ts:80
Take a predicate function and of it to become a Predicate (enabling you to call Predicate.and, and other logic operations on it)

Type parameters
- T
Parameters
- fn: function
  - - (x: T): boolean
    - Parameters
      - x: T
      Returns boolean
Returns Predicate<T>

Generated using TypeDoc