Class Filter

A query filter for DAOs.

Hierarchy

NestedRestriction
- Filter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Filter(...clauses: Clause[]): Filter

Inherited from NestedRestriction.constructor
- Defined in api/NestedRestriction.ts:22
Parameters
- Rest ...clauses: Clause[]
Returns Filter

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: Restriction | NestedRestriction): this

Inherited from NestedRestriction.withAndRestriction
- Defined in api/NestedRestriction.ts:34
Adds an additional restriction using the logical AND operator.

Parameters
- restriction: Restriction | NestedRestriction
Returns this

withOrRestriction

withOrRestriction(restriction: Restriction | NestedRestriction): this

Inherited from NestedRestriction.withOrRestriction
- Defined in api/NestedRestriction.ts:29
Adds an additional restriction using the logical OR operator.

Parameters
- restriction: Restriction | NestedRestriction
Returns this

withOrderBy

withOrderBy(order: OrderBy): this

- Defined in api/Filter.ts:30
Add the given order criteria to the filter.

Parameters
- order: OrderBy
Returns this

Static fromJson

fromJson(filter: any): Filter

Overrides NestedRestriction.fromJson
- Defined in api/Filter.ts:10
given a filter JSON structure, return a Filter object

Parameters
- filter: any
Returns Filter

Generated using TypeDoc