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