URLBuilder class

套件:

@azure/core-http

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

方法

appendPath(undefined | string)	將提供的路徑附加至此 URL 的現有路徑。 如果提供的路徑包含查詢，則也會將其新增至此 URL。
getHost()	取得在此 URL 中設定的主機。
getPath()	取得在此 URL 中設定的路徑。
getPort()	取得此 URL 中已設定的埠。
getQuery()	取得此 URL 中的查詢。
getQueryParameterValue(string)	取得具有所提供查詢參數名稱的查詢參數值。 如果所提供的名稱不存在任何查詢參數，則會傳回未定義的 。
getScheme()	取得此 URL 中已設定的配置。
parse(string)	將指定的字串 URL 剖析為新的 URLBuilder。
replaceAll(string, string)	如果在此 URLBuilder 中找到提供的 searchValue，請將它取代為提供的 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, unknown)	使用此 URL 查詢中提供的名稱和值來設定查詢參數。 如果提供的查詢參數值未定義或空白，則如果查詢參數存在，則會移除查詢參數。
setScheme(undefined | string)	設定此 URL 的配置/通訊協定。 如果提供的配置包含 URL 的其他部分 (，例如主機、埠、路徑或查詢) ，這些元件也會新增至此 URL。
toString()	將 URL 序列化為字串。

方法詳細資料

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)

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

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

參數

queryParameterName

string

傳回

undefined | string | string[]

getScheme()

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

function getScheme(): undefined | string

傳回

undefined | string

parse(string)

將指定的字串 URL 剖析為新的 URLBuilder。

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(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, unknown)

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

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

參數

queryParameterName

string

queryParameterValue

unknown

setScheme(undefined | string)

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

function setScheme(scheme: undefined | string)

參數

scheme

undefined | string

toString()

將 URL 序列化為字串。

function toString(): string

傳回

string

作為字串的 URL。