Class Query

A Query object is a convenience wrapper for setting up and configuring a query string used for API queries.

Hierarchy

Query

Index

Constructors

constructor

Methods

Constructors

constructor

new Query(conditions?: QueryCondition[]): Query

- Defined in src/network/api/params/Query.ts:63
Initializes a query instance, optionally with an array of query conditions.

memberof

Query

Parameters
- Default value conditions: QueryCondition[] = []
Returns Query

Methods

addCondition

addCondition(condition: QueryCondition): Query

- Defined in src/network/api/params/Query.ts:82
Adds a query condition.

memberof

Query

Parameters
- condition: QueryCondition
Returns Query

removeAllConditions

removeAllConditions(): Query

- Defined in src/network/api/params/Query.ts:108
Removes all query conditions.

memberof

Query

Returns Query

removeCondition

removeCondition(condition: QueryCondition): Query

- Defined in src/network/api/params/Query.ts:94
Removes a query condition.

memberof

Query

Parameters
- condition: QueryCondition
Returns Query

toString

toString(): string

- Defined in src/network/api/params/Query.ts:119
Returns the formatted string from all query conditions to be used for API requests.

memberof

Query

Returns string

Generated using TypeDoc