Class Filter

A query filter for DAOs.

Hierarchy (view full)

NestedRestriction
- Filter

Index

Constructors

Properties

clauses limit orderBy

Methods

withAndRestriction withOrRestriction withOrderBy fromJson

Constructors

constructor

new Filter(...clauses): Filter
Parameters
- Rest ...clauses: Clause[]
Returns Filter
Inherited from NestedRestriction.constructor
- Defined in src/api/NestedRestriction.ts:24

Properties

clauses

clauses: Clause[]

The clauses containing the nested restrictions and their logical operators.

limit

limit: number = 1000

how many results to get back by default

orderBy

orderBy: OrderBy[] = []

how to sort results

Methods

withAndRestriction

withAndRestriction(restriction): Filter
Adds an additional restriction using the logical AND operator.
Parameters
- restriction: Restriction | NestedRestriction
Returns Filter
Inherited from NestedRestriction.withAndRestriction
- Defined in src/api/NestedRestriction.ts:34

withOrRestriction

withOrRestriction(restriction): Filter
Adds an additional restriction using the logical OR operator.
Parameters
- restriction: Restriction | NestedRestriction
Returns Filter
Inherited from NestedRestriction.withOrRestriction
- Defined in src/api/NestedRestriction.ts:29

withOrderBy

withOrderBy(order): Filter
Add the given order criteria to the filter.
Parameters
- order: OrderBy
Returns Filter
- Defined in src/api/Filter.ts:30

`Static` fromJson

fromJson(filter): Filter
given a filter JSON structure, return a Filter object
Parameters
- filter: any
Returns Filter
Overrides NestedRestriction.fromJson
- Defined in src/api/Filter.ts:10