URLBuilder class

套件:

@azure/ms-rest-js

處理建立、修改和剖析 URL 的類別。

方法

appendPath(string | undefined)	將提供的路徑附加至此 URL 的現有路徑。 如果提供的路徑包含查詢，它也會新增至此 URL。
getHost()	取得此 URL 中設定的主機。
getPath()	取得此 URL 中設定的路徑。
getPort()	取得此 URL 中已設定的埠。
getQuery()	取得此 URL 中的查詢。
getQueryParameterValue(string)	使用提供的查詢參數名稱取得查詢參數的值。 如果所提供的名稱不存在任何查詢參數，則會傳回未定義。
getScheme()	取得此 URL 中已設定的配置。
parse(string)
replaceAll(string, string)	如果在此 URLBuilder 中找到提供的 searchValue，請將它取代為提供的 replaceValue。
setHost(string | undefined)	設定此 URL 的主機。 如果提供的主機包含 URL 的其他部分（例如埠、路徑或查詢），這些元件也會新增至此 URL。
setPath(string | undefined)	設定此 URL 的路徑。 如果提供的路徑包含查詢，它也會新增至此 URL。
setPort(string | number | undefined)	設定此 URL 的埠。 如果提供的埠包含 URL 的其他部分（例如路徑或查詢），這些元件也會新增至此 URL。
setQuery(string | undefined)	在此 URL 中設定查詢。
setQueryParameter(string, any)	使用此 URL 查詢中提供的名稱和值來設定查詢參數。 如果提供的查詢參數值未定義或空白，則如果查詢參數存在，則會移除查詢參數。
setScheme(string | undefined)	設定此 URL 的配置/通訊協定。 如果提供的配置包含 URL 的其他部分（例如主機、埠、路徑或查詢），這些元件也會新增至此 URL。
toString()

方法詳細資料

appendPath(string | undefined)

將提供的路徑附加至此 URL 的現有路徑。 如果提供的路徑包含查詢，它也會新增至此 URL。

function appendPath(path: string | undefined)

參數

path

string | undefined

getHost()

取得此 URL 中設定的主機。

function getHost(): string | undefined

傳回

string | undefined

getPath()

取得此 URL 中設定的路徑。

function getPath(): string | undefined

傳回

string | undefined

getPort()

取得此 URL 中已設定的埠。

function getPort(): string | undefined

傳回

string | undefined

getQuery()

取得此 URL 中的查詢。

function getQuery(): string | undefined

傳回

string | undefined

getQueryParameterValue(string)

使用提供的查詢參數名稱取得查詢參數的值。 如果所提供的名稱不存在任何查詢參數，則會傳回未定義。

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

參數

queryParameterName

string

傳回

string | string[] | undefined

getScheme()

取得此 URL 中已設定的配置。

function getScheme(): string | undefined

傳回

string | undefined

parse(string)

static function parse(text: string): URLBuilder

參數

text

string

傳回

URLBuilder

replaceAll(string, string)

如果在此 URLBuilder 中找到提供的 searchValue，請將它取代為提供的 replaceValue。

function replaceAll(searchValue: string, replaceValue: string)

參數

searchValue

string

replaceValue

string

setHost(string | undefined)

設定此 URL 的主機。 如果提供的主機包含 URL 的其他部分（例如埠、路徑或查詢），這些元件也會新增至此 URL。

function setHost(host: string | undefined)

參數

host

string | undefined

setPath(string | undefined)

設定此 URL 的路徑。 如果提供的路徑包含查詢，它也會新增至此 URL。

function setPath(path: string | undefined)

參數

path

string | undefined

setPort(string | number | undefined)

設定此 URL 的埠。 如果提供的埠包含 URL 的其他部分（例如路徑或查詢），這些元件也會新增至此 URL。

function setPort(port: string | number | undefined)

參數

port

string | number | undefined

setQuery(string | undefined)

在此 URL 中設定查詢。

function setQuery(query: string | undefined)

參數

query

string | undefined

setQueryParameter(string, any)

使用此 URL 查詢中提供的名稱和值來設定查詢參數。 如果提供的查詢參數值未定義或空白，則如果查詢參數存在，則會移除查詢參數。

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

參數

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

設定此 URL 的配置/通訊協定。 如果提供的配置包含 URL 的其他部分（例如主機、埠、路徑或查詢），這些元件也會新增至此 URL。

function setScheme(scheme: string | undefined)

參數

scheme

string | undefined

toString()

function toString(): string

傳回

string