Class Predicates

Predicates to constrain the results to be retrieved.

Hierarchy

Predicates

Index

Methods

Methods

Static and

and(...predicates: Predicate[]): Predicate

- Defined in api/Predicates.ts:348
description

joins Predicates functions with and validation.

Parameters
- Rest ...predicates: Predicate[]
Returns Predicate

Static andOperation

andOperation(predicates: Predicate[]): Predicate

- Defined in api/Predicates.ts:372
description

joins Predicates functions with and validation.

Parameters
- predicates: Predicate[]
Returns Predicate

Static between

between(key: string, startValue: any, endValue: any): Predicate

- Defined in api/Predicates.ts:156
description

checks given value of data by key between given startValue and given endValue.

Parameters
- key: string
- startValue: any
- endValue: any
Returns Predicate

Static Private checkEquality

checkEquality(key: string, value: any, caseSensitive: boolean, check: CheckEquality): Predicate

- Defined in api/Predicates.ts:48
description

checks equality given value and given value of data by key.

Parameters
- key: string
- value: any
- caseSensitive: boolean
- check: CheckEquality
Returns Predicate

Static checkLike

checkLike(data: Props<any>, key: string, value: any, fromLeft: boolean, fromRight: boolean, caseSensitive?: boolean): boolean

- Defined in api/Predicates.ts:177
Parameters
- data: Props<any>
- key: string
- value: any
- fromLeft: boolean
- fromRight: boolean
- Optional caseSensitive: boolean
Returns boolean

Static endsWith

endsWith(key: string, value: any, caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:221
description

checks given value of data by key endsWith given value by caseSensitive parameter.

Parameters
- key: string
- value: any
- Optional caseSensitive: boolean
Returns Predicate

Static eq

eq(key: string, value: any, caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:94
description

checks equality given value and given value of data by key.

Parameters
- key: string
- value: any
- Optional caseSensitive: boolean
Returns Predicate

Static gt

gt(key: string, value: any): Predicate

- Defined in api/Predicates.ts:135
description

checks given value of data by key greater then given value .

Parameters
- key: string
- value: any
Returns Predicate

Static gte

gte(key: string, value: any): Predicate

- Defined in api/Predicates.ts:145
description

checks given value of data by key greater then or equals given value .

Parameters
- key: string
- value: any
Returns Predicate

Static in

in(key: string, values: any[], caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:243
description

checks given value of data by key in given array values by caseSensitive parameter.

Parameters
- key: string
- values: any[]
- Optional caseSensitive: boolean
Returns Predicate

Static isEmpty

isEmpty(key: string): Predicate

- Defined in api/Predicates.ts:294
description

checks given value of data by key is empty.

Parameters
- key: string
Returns Predicate

Static isFalse

isFalse(key: string): Predicate

- Defined in api/Predicates.ts:83
description

checks equality given value and given value of data by key.

Parameters
- key: string
Returns Predicate

Static isNotEmpty

isNotEmpty(key: string): Predicate

- Defined in api/Predicates.ts:327
description

checks given value of data by key is not empty.

Parameters
- key: string
Returns Predicate

Static isNotNull

isNotNull(key: string): Predicate

- Defined in api/Predicates.ts:283
description

checks given value of data by key is not null.

Parameters
- key: string
Returns Predicate

Static isNull

isNull(key: string): Predicate

- Defined in api/Predicates.ts:271
description

checks given value of data by key is null.

Parameters
- key: string
Returns Predicate

Static isTrue

isTrue(key: string): Predicate

- Defined in api/Predicates.ts:74
description

checks equality given value and given value of data by key.

Parameters
- key: string
Returns Predicate

Static like

like(key: string, value: any, caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:232
description

checks given value of data by key like given value by caseSensitive parameter.

Parameters
- key: string
- value: any
- Optional caseSensitive: boolean
Returns Predicate

Static likeIn

likeIn(key: string, values: any[], caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:258
description

checks given value of data by key in given array values by caseSensitive parameter.

Parameters
- key: string
- values: any[]
- Optional caseSensitive: boolean
Returns Predicate

Static lt

lt(key: string, value: any): Predicate

- Defined in api/Predicates.ts:115
description

checks given value of data by key less then given value .

Parameters
- key: string
- value: any
Returns Predicate

Static lte

lte(key: string, value: any): Predicate

- Defined in api/Predicates.ts:125
description

checks given value of data by key less then or equals given value .

Parameters
- key: string
- value: any
Returns Predicate

Static neq

neq(key: string, value: any, caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:105
description

checks equality given value and given value of data by key.

Parameters
- key: string
- value: any
- Optional caseSensitive: boolean
Returns Predicate

Static op

op(key: string, op: string, value: any): Predicate

- Defined in api/Predicates.ts:28
description

evulates op and execute it.

Parameters
- key: string
- op: string
- value: any
Returns Predicate

Static or

or(...predicates: Predicate[]): Predicate

- Defined in api/Predicates.ts:339
description

joins Predicates functions with or validation.

Parameters
- Rest ...predicates: Predicate[]
Returns Predicate

Static orOperation

orOperation(predicates: Predicate[]): Predicate

- Defined in api/Predicates.ts:357
description

joins Predicates functions with or validation.

Parameters
- predicates: Predicate[]
Returns Predicate

Static query

query(value: string, ignoreList?: string[]): Predicate

- Defined in api/Predicates.ts:307
Parameters
- value: string
- Optional ignoreList: string[]
Returns Predicate

Static startsWith

startsWith(key: string, value: any, caseSensitive?: boolean): Predicate

- Defined in api/Predicates.ts:210
description

checks given value of data by key startsWith given value by caseSensitive parameter.

Parameters
- key: string
- value: any
- Optional caseSensitive: boolean
Returns Predicate

Generated using TypeDoc