URLBuilder class

Пакет:

@azure/core-http

Класс, обрабатывающий создание, изменение и анализ URL-адресов.

Методы

appendPath(undefined | string)	Добавьте указанный путь к существующему url-адресу. Если указанный путь содержит запрос, он также будет добавлен в этот URL-адрес.
getHost()	Получите узел, который был задан в этом URL-адресе.
getPath()	Получите путь, заданный в этом URL-адресе.
getPort()	Получите порт, который был задан в этом URL-адресе.
getQuery()	Получите запрос по этому URL-адресу.
getQueryParameterValue(string)	Получите значение параметра запроса с указанным именем параметра запроса. Если не существует параметра запроса с указанным именем, возвращается значение undefined.
getScheme()	Получите схему, заданную в этом URL-адресе.
parse(string)	Анализирует url-адрес заданной строки в новый URLBuilder.
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, 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)

Получите значение параметра запроса с указанным именем параметра запроса. Если не существует параметра запроса с указанным именем, возвращается значение undefined.

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)

Если указанное значение 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, 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-адрес в виде строки.