URLBuilder class

パッケージ:

@azure/ms-rest-js

URL の作成、変更、解析を処理するクラス。

メソッド

appendPath(undefined | string)	指定したパスをこの URL の既存のパスに追加します。 指定されたパスにクエリが含まれている場合は、この URL にも追加されます。
getHost()	この URL に設定されているホストを取得します。
getPath()	この URL に設定されているパスを取得します。
getPort()	この URL に設定されているポートを取得します。
getQuery()	この URL でクエリを取得します。
getQueryParameterValue(string)	指定されたクエリ パラメーター名を使用して、クエリ パラメーターの値を取得します。 指定された名前のクエリ パラメーターが存在しない場合は、undefined が返されます。
getScheme()	この URL に設定されているスキームを取得します。
parse(string)
replaceAll(string, string)	指定した searchValue がこの URLBuilder で見つかった場合は、それを指定された replaceValue に置き換えます。
setHost(undefined | string)	この URL のホストを設定します。 指定されたホストに URL の他の部分 (ポート、パス、クエリなど) が含まれている場合、それらの部分もこの URL に追加されます。
setPath(undefined | string)	この URL のパスを設定します。 指定されたパスにクエリが含まれている場合は、この URL にも追加されます。
setPort(undefined | string | number)	この URL のポートを設定します。 指定されたポートに URL の他の部分 (パスやクエリなど) が含まれている場合、それらの部分もこの URL に追加されます。
setQuery(undefined | string)	この URL にクエリを設定します。
setQueryParameter(string, any)	この URL のクエリで、指定された名前と値を使用してクエリ パラメーターを設定します。 指定されたクエリ パラメーター値が未定義または空の場合、クエリ パラメーターが存在する場合は削除されます。
setScheme(undefined | string)	この URL のスキーム/プロトコルを設定します。 指定されたスキームに URL の他の部分 (ホスト、ポート、パス、クエリなど) が含まれている場合、それらの部分もこの URL に追加されます。
toString()

メソッドの詳細

appendPath(undefined | string)

指定したパスをこの URL の既存のパスに追加します。 指定されたパスにクエリが含まれている場合は、この URL にも追加されます。

function appendPath(path: undefined | string)

パラメーター

path

undefined | string

getHost()

この URL に設定されているホストを取得します。

function getHost(): undefined | string

戻り値

undefined | string

getPath()

この URL に設定されているパスを取得します。

function getPath(): undefined | string

戻り値

undefined | string

getPort()

この URL に設定されているポートを取得します。

function getPort(): undefined | string

戻り値

undefined | string

getQuery()

この URL でクエリを取得します。

function getQuery(): undefined | string

戻り値

undefined | string

getQueryParameterValue(string)

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

function getQueryParameterValue(queryParameterName: string): undefined | string | string[]

パラメーター

queryParameterName

string

戻り値

undefined | string | string[]

getScheme()

この URL に設定されているスキームを取得します。

function getScheme(): undefined | string

戻り値

undefined | string

parse(string)

static function parse(text: string): URLBuilder

パラメーター

text

string

戻り値

URLBuilder

replaceAll(string, string)

指定した searchValue がこの URLBuilder で見つかった場合は、それを指定された replaceValue に置き換えます。

function replaceAll(searchValue: string, replaceValue: string)

パラメーター

searchValue

string

replaceValue

string

setHost(undefined | string)

この URL のホストを設定します。 指定されたホストに URL の他の部分 (ポート、パス、クエリなど) が含まれている場合、それらの部分もこの URL に追加されます。

function setHost(host: undefined | string)

パラメーター

host

undefined | string

setPath(undefined | string)

この URL のパスを設定します。 指定されたパスにクエリが含まれている場合は、この URL にも追加されます。

function setPath(path: undefined | string)

パラメーター

path

undefined | string

setPort(undefined | string | number)

この URL のポートを設定します。 指定されたポートに URL の他の部分 (パスやクエリなど) が含まれている場合、それらの部分もこの URL に追加されます。

function setPort(port: undefined | string | number)

パラメーター

port

undefined | string | number

setQuery(undefined | string)

この URL にクエリを設定します。

function setQuery(query: undefined | string)

パラメーター

query

undefined | string

setQueryParameter(string, any)

この URL のクエリで、指定された名前と値を使用してクエリ パラメーターを設定します。 指定されたクエリ パラメーター値が未定義または空の場合、クエリ パラメーターが存在する場合は削除されます。

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

パラメーター

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

この URL のスキーム/プロトコルを設定します。 指定されたスキームに URL の他の部分 (ホスト、ポート、パス、クエリなど) が含まれている場合、それらの部分もこの URL に追加されます。

function setScheme(scheme: undefined | string)

パラメーター

scheme

undefined | string

toString()

function toString(): string

戻り値

string