你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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。