Class QueryFilter

The class builds various filters for a query.

Hierarchy

QueryFilter

Index

Methods

Methods

Static and

and(filter: Filter | Filter[], ...extra: Filter[]): GroupFilter

Links 2 or more filters with an AND logical operator and returns them as a group of filters.

Parameters
- filter: Filter | Filter[]
  
  One or more filter conditions.
- Rest ...extra: Filter[]
  
  Additional filters.
Returns GroupFilter

Static begins

begins(fieldName: string, value: string): Filter

Builds a BEGINS WITH filter.

Parameters
- fieldName: string
  
  The field name.
- value: string
  
  The filter value.
Returns Filter

Static check

check(filter: Object): void

Checks if a filter or a group of filters is/are valid.

Parameters
- filter: Object
  
  The filter condition/group.
Returns void

Static contains

contains(fieldName: string, value: string): Filter

Builds a CONTAINS filter, only works with fields part of an Word index.

Parameters
- fieldName: string
  
  The field name.
- value: string
  
  The filter value.
Returns Filter

Static eq

eq(fieldName: string, value: string | boolean | number | Date): Filter

Builds an equality field filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | boolean | number | Date
  
  The filter value.
Returns Filter

Static filter

filter(op: CompareOperator | StringOperator, fieldName: string, value: string | boolean | number | Date): Filter

Builds an filter filter condition using the operator specified.

Parameters
- op: CompareOperator | StringOperator
  
  The filter operator.
- fieldName: string
  
  The field name.
- value: string | boolean | number | Date
  
  The filter value.
Returns Filter

Static ge

ge(fieldName: string, value: string | number | Date): Filter

Builds a GREATER OR EQUAL filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | number | Date
  
  The filter value.
Returns Filter

Static gt

gt(fieldName: string, value: string | number | Date): Filter

Builds a GREATER THAN filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | number | Date
  
  The filter value.
Returns Filter

Static le

le(fieldName: string, value: string | number | Date): Filter

Builds a LESS OR EQUAL filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | number | Date
  
  The filter value.
Returns Filter

Static like

like(fieldName: string, value: string): Filter

Builds a LIKE filter, alias to matches.

Parameters
- fieldName: string
  
  The field name.
- value: string
  
  The filter value.
Returns Filter

Static lookup

lookup(fieldName: string, ...values: (string | number | Date)[]): GroupFilter

Builds a LOOKUP filter.

Parameters
- fieldName: string
  
  The field name.
- Rest ...values: (string | number | Date)[]
  
  The list of filter values.
Returns GroupFilter

Static lt

lt(fieldName: string, value: string | number | Date): Filter

Builds a LESS THAN filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | number | Date
  
  The filter value.
Returns Filter

Static matches

matches(fieldName: string, value: string): Filter

Builds a MATCHES filter.

Parameters
- fieldName: string
  
  The field name.
- value: string
  
  The filter value.
Returns Filter

Static ne

ne(fieldName: string, value: string | boolean | number | Date): Filter

Builds a NOT EQUAL filter.

Parameters
- fieldName: string
  
  The field name.
- value: string | boolean | number | Date
  
  The filter value.
Returns Filter

Static not

not(filter: Filter | Filter[], ...extra: Filter[]): GroupFilter

Negate one or more filter conditions, if more the whole will be negated as a group (AND).

Parameters
- filter: Filter | Filter[]
  
  One or more filter conditions.
- Rest ...extra: Filter[]
  
  Additional filters.
Returns GroupFilter

Static or

or(filter: Filter | Filter[], ...extra: Filter[]): GroupFilter

Links 2 or more filters with an OR logical operator and returns them as a group of filters.

Parameters
- filter: Filter | Filter[]
  
  One or more filter conditions.
- Rest ...extra: Filter[]
  
  Additional filters.
Returns GroupFilter

Static rowid

rowid(tableName: string, value: string): Filter

Builds a ROWID filter.

Parameters
- tableName: string
  
  The table name.
- value: string
  
  The filter row identifier.
Returns Filter