Class URLQuery

Package version

A class that handles the query portion of a URLBuilder.

Hierarchy

URLQuery

Index

Methods

Methods

any

any(): boolean

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:19
Get whether or not there any query parameters in this URLQuery.

Returns boolean

get

get(parameterName: string): string | string[] | undefined

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:55
Get the value of the query parameter with the provided name. If no parameter exists with the provided parameter name, then undefined will be returned.

Parameters
- parameterName: string
Returns string | string[] | undefined

keys

keys(): string[]

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:26
Get the keys of the query string.

Returns string[]

set

set(parameterName: string, parameterValue: unknown): void

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:35
Set a query parameter with the provided name and value. If the parameterValue is undefined or empty, then this will attempt to remove an existing query parameter with the provided parameterName.

Parameters
- parameterName: string
- parameterValue: unknown
Returns void

toString

toString(): string

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:62
Get the string representation of this query. The return value will not start with a "?".

Returns string

Static parse

parse(text: string): URLQuery

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/url.ts:85
Parse a URLQuery from the provided text.

Parameters
- text: string
Returns URLQuery

Generated using TypeDoc