URLQuery class

パッケージ:

@azure/core-http

URLBuilder のクエリ部分を処理するクラス。

メソッド

any()	この URLQuery にクエリ パラメーターがあるかどうかを取得します。
get(string)	指定された名前のクエリ パラメーターの値を取得します。 指定されたパラメーター名を持つパラメーターが存在しない場合は、undefined が返されます。
keys()	クエリ文字列のキーを取得します。
parse(string)	指定されたテキストから URLQuery を解析します。
set(string, unknown)	指定された名前と値を使用してクエリ パラメーターを設定します。 parameterValue が未定義または空の場合、指定された parameterName を持つ既存のクエリ パラメーターの削除が試みられます。
toString()	このクエリの文字列表現を取得します。 戻り値は "?"" で始まるものではありません。

メソッドの詳細

any()

この URLQuery にクエリ パラメーターがあるかどうかを取得します。

function any(): boolean

戻り値

boolean

get(string)

指定された名前のクエリ パラメーターの値を取得します。 指定されたパラメーター名を持つパラメーターが存在しない場合は、undefined が返されます。

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

パラメーター

parameterName

string

戻り値

undefined | string | string[]

keys()

クエリ文字列のキーを取得します。

function keys(): string[]

戻り値

string[]

parse(string)

指定されたテキストから URLQuery を解析します。

static function parse(text: string): URLQuery

パラメーター

text

string

戻り値

URLQuery

set(string, unknown)

指定された名前と値を使用してクエリ パラメーターを設定します。 parameterValue が未定義または空の場合、指定された parameterName を持つ既存のクエリ パラメーターの削除が試みられます。

function set(parameterName: string, parameterValue: unknown)

パラメーター

parameterName

string

parameterValue

unknown

toString()

このクエリの文字列表現を取得します。 戻り値は "?"" で始まるものではありません。

function toString(): string

戻り値

string