routier-collection

---

routier-collection / core/src / Query

Class: Query<TRoot, TShape>

Defined in: core/src/plugins/query/Query.ts:6

Type Parameters

TRoot

TRoot extends object

TShape

TShape

Implements

• IQuery<TRoot, TShape>

Constructors

Constructor

new Query<TRoot, TShape>(options, schema, enableChangeTrackingOverride?): Query<TRoot, TShape>

Defined in: core/src/plugins/query/Query.ts:12

Parameters

options

QueryOptionsCollection<TShape>

schema

CompiledSchema<TRoot>

enableChangeTrackingOverride?

boolean

Returns

Query<TRoot, TShape>

Properties

options

readonly options: QueryOptionsCollection<TShape>

Defined in: core/src/plugins/query/Query.ts:8

Query options (sort, skip, take, etc.).

Implementation of

IQuery.options

---

schema

readonly schema: CompiledSchema<TRoot>

Defined in: core/src/plugins/query/Query.ts:9

Implementation of

IQuery.schema

Accessors

changeTracking

Get Signature

get changeTracking(): boolean

Defined in: core/src/plugins/query/Query.ts:23

Whether change tracking is enabled for the query result. Only enabled when the response is not reduced/aggregated/mapped.

Returns

boolean

Implementation of

IQuery.changeTracking

Methods

EMPTY()

static EMPTY<T, S>(schema): Query<T, S>

Defined in: core/src/plugins/query/Query.ts:49

Type Parameters

T

T extends object

S

S

Parameters

schema

CompiledSchema<T>

Returns

Query<T, S>

---

isEmpty()

static isEmpty<T, S>(query): boolean

Defined in: core/src/plugins/query/Query.ts:53

Type Parameters

T

T extends object

S

S

Parameters

query

IQuery<T, S>

Returns

boolean

---

toString()

static toString<TRoot, TShape>(query): string

Defined in: core/src/plugins/query/Query.ts:57

Type Parameters

TRoot

TRoot extends object

TShape

TShape

Parameters

query

IQuery<TRoot, TShape>

Returns

string