Class Filter

A query filter for DAOs.

Hierarchy (View Summary)

API.NestedRestriction
- Filter

Index

Constructors

Properties

clauses limit orderBy

Methods

withAndRestriction withOrderBy withOrRestriction fromJson

Constructors

constructor

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

Properties

clauses

clauses: API.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: API.OrderBy[] = []

how to sort results

Methods

withAndRestriction

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

withOrderBy

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

withOrRestriction

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

`Static`fromJson

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