Class Restrictions

Resrictions to constrain the results to be retrieved.

Hierarchy

Restrictions

Index

Methods

Methods

Static and

and(...restrictions: RestrictionItem[]): RestrictionItem

- Defined in api/Restrictions.ts:250
description

joins Restrictions functions with and validation.

Parameters
- Rest ...restrictions: RestrictionItem[]
Returns RestrictionItem

Static between

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

- Defined in api/Restrictions.ts:129
description

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

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

Static endsWith

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

- Defined in api/Restrictions.ts:151
description

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

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

Static eq

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

- Defined in api/Restrictions.ts:67
description

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

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

Static gt

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

- Defined in api/Restrictions.ts:108
description

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

Parameters
- key: string
- value: any
Returns RestrictionItem

Static gte

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

- Defined in api/Restrictions.ts:118
description

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

Parameters
- key: string
- value: any
Returns RestrictionItem

Static in

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

- Defined in api/Restrictions.ts:175
description

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

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

Static isEmpty

isEmpty(key: string): RestrictionItem

- Defined in api/Restrictions.ts:213
description

checks given value of data by key is empty.

Parameters
- key: string
Returns RestrictionItem

Static Private isFalse

isFalse(key: string): RestrictionItem

- Defined in api/Restrictions.ts:56
description

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

Parameters
- key: string
Returns RestrictionItem

Static isNotEmpty

isNotEmpty(key: string): RestrictionItem

- Defined in api/Restrictions.ts:222
description

checks given value of data by key is not empty.

Parameters
- key: string
Returns RestrictionItem

Static isNotNull

isNotNull(key: string): RestrictionItem

- Defined in api/Restrictions.ts:204
description

checks given value of data by key is not null.

Parameters
- key: string
Returns RestrictionItem

Static isNull

isNull(key: string): RestrictionItem

- Defined in api/Restrictions.ts:195
description

checks given value of data by key is null.

Parameters
- key: string
Returns RestrictionItem

Static Private isTrue

isTrue(key: string): RestrictionItem

- Defined in api/Restrictions.ts:46
description

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

Parameters
- key: string
Returns RestrictionItem

Static like

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

- Defined in api/Restrictions.ts:164
description

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

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

Static likeIn

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

- Defined in api/Restrictions.ts:186
description

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

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

Static lt

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

- Defined in api/Restrictions.ts:88
description

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

Parameters
- key: string
- value: any
Returns RestrictionItem

Static lte

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

- Defined in api/Restrictions.ts:98
description

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

Parameters
- key: string
- value: any
Returns RestrictionItem

Static neq

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

- Defined in api/Restrictions.ts:78
description

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

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

Static op

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

- Defined in api/Restrictions.ts:36
description

evulates op and execute it.

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

Static Private operateMultiple

operateMultiple(op: string, restrictions: RestrictionItem[], predicateMultiple: PredicateMultiple): RestrictionItem

- Defined in api/Restrictions.ts:261
description

joins Restrictions functions with and validation.

Parameters
- op: string
- restrictions: RestrictionItem[]
- predicateMultiple: PredicateMultiple
Returns RestrictionItem

Static or

or(...restrictions: RestrictionItem[]): RestrictionItem

- Defined in api/Restrictions.ts:241
description

joins Restrictions functions with or validation.

Parameters
- Rest ...restrictions: RestrictionItem[]
Returns RestrictionItem

Static query

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

- Defined in api/Restrictions.ts:232
Parameters
- value: string
- Optional ignoreList: string[]
Returns RestrictionItem

Static startsWith

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

- Defined in api/Restrictions.ts:140
description

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

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

Static wrap

wrap(key: string, op: string, predicate: Predicate): RestrictionItem

- Defined in api/Restrictions.ts:21
Parameters
- key: string
- op: string
- predicate: Predicate
Returns RestrictionItem

Generated using TypeDoc