Class QueryBuilder

Provides a means for parsing and building a set of parameters.

In other languages, dictionaries are not reliable for retaining the order of stored values. So for certainty and flexibility we use an ordered dictionary as a base class.

Hierarchy

default<string, Value | Value[]>
- QueryBuilder

Index

Constructors

Methods

encode import importFromString importQuery importSingle importValues toString init

Constructors

constructor

new QueryBuilder(query: Convertible, decodeValues?: boolean): QueryBuilder
Parameters
- query: Convertible
- decodeValues: boolean = true
Returns QueryBuilder
Overrides OrderedRegistry<string, UriComponent.Value | UriComponent.Value[]>.constructor
- Defined in QueryBuilder.ts:23

Methods

encode

encode(prefixIfNotEmpty?: boolean): string
Returns the encoded URI string
Parameters
- Optional prefixIfNotEmpty: boolean
Returns string
- Defined in QueryBuilder.ts:158

import

import(key: string, value: Value | Value[]): QueryBuilder
Adds a key+value or set of values by key.

Returns
Parameters
- key: string
- value: Value | Value[]
Returns QueryBuilder
- Defined in QueryBuilder.ts:107

importFromString

importFromString(values: string, deserialize?: boolean, decodeValues?: boolean): QueryBuilder
Property parses the components of an URI into their values or array of values.

Returns
Parameters
- values: string
- deserialize: boolean = true
- decodeValues: boolean = true
Returns QueryBuilder
- Defined in QueryBuilder.ts:141

importQuery

importQuery(query: Convertible, decodeValues?: boolean): QueryBuilder
Accepts any convertible query parameter and imports the values.

Returns
Parameters
- query: Convertible
- decodeValues: boolean = true
Returns QueryBuilder
- Defined in QueryBuilder.ts:52

importSingle

importSingle(key: string, value: Value): QueryBuilder
Adds a key+value to the query.

Returns
Parameters
- key: string
- value: Value
Returns QueryBuilder
- Defined in QueryBuilder.ts:83

importValues

importValues(values: Values): QueryBuilder
Imports a set of key+values.

Returns
Parameters
- values: Values
Returns QueryBuilder
- Defined in QueryBuilder.ts:125

toString

toString(): string
Returns string
- Defined in QueryBuilder.ts:163

`Static` init

init(query: Convertible, decodeValues?: boolean): QueryBuilder
Creates a new QueryBuilder using the provided query.

Returns
Parameters
- query: Convertible
- decodeValues: boolean = true
Returns QueryBuilder
- Defined in QueryBuilder.ts:39

Generated using TypeDoc