Class DataFilter<T>

Data filter generator

Type Parameters

T = any

Hierarchy

DataFilter

Index

Constructors

Properties

Methods

and any contains custom endsWith equals greaterOrEquals greaterThan into isNotNull isNull lessOrEquals lessThan not notEquals or startsWith

Constructors

constructor

new DataFilter<T>(query: GenericFilter<ModelKeyName<T>>): DataFilter<T>
Type Parameters
- T = any
Parameters
- query: GenericFilter<ModelKeyName<T>>
Returns DataFilter<T>
- Defined in finder.ts:211

Properties

query

query: GenericFilter<ModelKeyName<T>>

Methods

`Static` and

and<T>(...args: DataFilter<T>[]): DataFilter<T>
Require all conditions to match
Type Parameters
- T = any
Parameters
- Rest ...args: DataFilter<T>[]
  
  conditions
Returns DataFilter<T>
- Defined in finder.ts:20

`Static` any

any(): DataFilter<any>
Finds anything (no conditions)

Returns DataFilter<any>
- Defined in finder.ts:197

`Static` contains

contains<T>(key: ModelKeyName<T>, value: string, ignoreCase?: boolean): DataFilter<T>
Requires key.contains(value)
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: string
  
  The value
- Optional ignoreCase: boolean
  
  true to ignore case
Returns DataFilter<T>
- Defined in finder.ts:182

`Static` custom

custom(query: GenericFilter): DataFilter<any>
Custom query
Parameters
- query: GenericFilter
  
  The query
Returns DataFilter<any>
- Defined in finder.ts:205

`Static` endsWith

endsWith<T>(key: ModelKeyName<T>, value: string, ignoreCase?: boolean): DataFilter<T>
Requires key.endsWith(value)
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: string
  
  The value
- Optional ignoreCase: boolean
  
  true to ignore case
Returns DataFilter<T>
- Defined in finder.ts:164

`Static` equals

equals<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key == value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:63

`Static` greaterOrEquals

greaterOrEquals<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key >= value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:91

`Static` greaterThan

greaterThan<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key > value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:82

`Static` into

into<T>(key: ModelKeyName<T>, values: any[]): DataFilter<T>
Requires key in values
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- values: any[]
  
  The values
Returns DataFilter<T>
- Defined in finder.ts:118

`Static` isNotNull

isNotNull<T>(key: ModelKeyName<T>): DataFilter<T>
Requires key != null
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
Returns DataFilter<T>
- Defined in finder.ts:136

`Static` isNull

isNull<T>(key: ModelKeyName<T>): DataFilter<T>
Requires key == null
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
Returns DataFilter<T>
- Defined in finder.ts:127

`Static` lessOrEquals

lessOrEquals<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key <= value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:109

`Static` lessThan

lessThan<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key < value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:100

`Static` not

not<T>(arg: DataFilter<T>): DataFilter<T>
Negates the condition
Type Parameters
- T = any
Parameters
- arg: DataFilter<T>
  
  condition
Returns DataFilter<T>
- Defined in finder.ts:54

`Static` notEquals

notEquals<T>(key: ModelKeyName<T>, value: any): DataFilter<T>
Requires key != value
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: any
  
  The value
Returns DataFilter<T>
- Defined in finder.ts:73

`Static` or

or<T>(...args: DataFilter<T>[]): DataFilter<T>
Require one of the conditions to match
Type Parameters
- T = any
Parameters
- Rest ...args: DataFilter<T>[]
  
  conditions
Returns DataFilter<T>
- Defined in finder.ts:37

`Static` startsWith

startsWith<T>(key: ModelKeyName<T>, value: string, ignoreCase?: boolean): DataFilter<T>
Requires key.startsWith(value)
Type Parameters
- T = any
Parameters
- key: ModelKeyName<T>
  
  The key
- value: string
  
  The value
- Optional ignoreCase: boolean
  
  true to ignore case
Returns DataFilter<T>
- Defined in finder.ts:146

Generated using TypeDoc