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)	Если предоставленное searchValue найдено в этом URLBuilder, замените его предоставленным 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)

Если предоставленное searchValue найдено в этом URLBuilder, замените его предоставленным 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