URLBuilder class

Pacote:

@azure/core-http

Uma classe que manipula a criação, modificação e análise de URLs.

Métodos

appendPath(string | undefined)	Acrescente o caminho fornecido ao caminho existente dessa URL. Se o caminho fornecido contiver uma consulta, ele também será adicionado a essa URL.
getHost()	Obtenha o host que foi definido nesta URL.
getPath()	Obtenha o caminho que foi definido nesta URL.
getPort()	Obtenha a porta que foi definida nesta URL.
getQuery()	Obtenha a consulta nesta URL.
getQueryParameterValue(string)	Obtenha o valor do parâmetro de consulta com o nome do parâmetro de consulta fornecido. Se nenhum parâmetro de consulta existir com o nome fornecido, indefinido será retornado.
getScheme()	Obtenha o esquema que foi definido nesta URL.
parse(string)	Analisa uma determinada URL de cadeia de caracteres em um novo URLBuilder.
replaceAll(string, string)	Se o searchValue fornecido for encontrado neste URLBuilder, substitua-o pelo replaceValue fornecido.
setHost(string | undefined)	Defina o host para essa URL. Se o host fornecido contiver outras partes de uma URL (como uma porta, caminho ou consulta), essas partes também serão adicionadas a essa URL.
setPath(string | undefined)	Defina o caminho para essa URL. Se o caminho fornecido contiver uma consulta, ele também será adicionado a essa URL.
setPort(number | string | undefined)	Defina a porta para essa URL. Se a porta fornecida contiver outras partes de uma URL (como um caminho ou consulta), essas partes também serão adicionadas a essa URL.
setQuery(string | undefined)	Defina a consulta nesta URL.
setQueryParameter(string, unknown)	Defina um parâmetro de consulta com o nome e o valor fornecidos na consulta dessa URL. Se o valor do parâmetro de consulta fornecido estiver indefinido ou vazio, o parâmetro de consulta será removido se existir.
setScheme(string | undefined)	Defina o esquema/protocolo para essa URL. Se o esquema fornecido contiver outras partes de uma URL (como um host, porta, caminho ou consulta), essas partes também serão adicionadas a essa URL.
toString()	Serializa a URL como uma cadeia de caracteres.

Detalhes do método

appendPath(string | undefined)

Acrescente o caminho fornecido ao caminho existente dessa URL. Se o caminho fornecido contiver uma consulta, ele também será adicionado a essa URL.

function appendPath(path: string | undefined)

Parâmetros

path

string | undefined

getHost()

Obtenha o host que foi definido nesta URL.

function getHost(): string | undefined

Retornos

string | undefined

getPath()

Obtenha o caminho que foi definido nesta URL.

function getPath(): string | undefined

Retornos

string | undefined

getPort()

Obtenha a porta que foi definida nesta URL.

function getPort(): string | undefined

Retornos

string | undefined

getQuery()

Obtenha a consulta nesta URL.

function getQuery(): string | undefined

Retornos

string | undefined

getQueryParameterValue(string)

Obtenha o valor do parâmetro de consulta com o nome do parâmetro de consulta fornecido. Se nenhum parâmetro de consulta existir com o nome fornecido, indefinido será retornado.

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

Parâmetros

queryParameterName

string

Retornos

string | string[] | undefined

getScheme()

Obtenha o esquema que foi definido nesta URL.

function getScheme(): string | undefined

Retornos

string | undefined

parse(string)

Analisa uma determinada URL de cadeia de caracteres em um novo URLBuilder.

static function parse(text: string): URLBuilder

Parâmetros

text

string

Retornos

URLBuilder

replaceAll(string, string)

Se o searchValue fornecido for encontrado neste URLBuilder, substitua-o pelo replaceValue fornecido.

function replaceAll(searchValue: string, replaceValue: string)

Parâmetros

searchValue

string

replaceValue

string

setHost(string | undefined)

Defina o host para essa URL. Se o host fornecido contiver outras partes de uma URL (como uma porta, caminho ou consulta), essas partes também serão adicionadas a essa URL.

function setHost(host: string | undefined)

Parâmetros

host

string | undefined

setPath(string | undefined)

Defina o caminho para essa URL. Se o caminho fornecido contiver uma consulta, ele também será adicionado a essa URL.

function setPath(path: string | undefined)

Parâmetros

path

string | undefined

setPort(number | string | undefined)

Defina a porta para essa URL. Se a porta fornecida contiver outras partes de uma URL (como um caminho ou consulta), essas partes também serão adicionadas a essa URL.

function setPort(port: number | string | undefined)

Parâmetros

port

number | string | undefined

setQuery(string | undefined)

Defina a consulta nesta URL.

function setQuery(query: string | undefined)

Parâmetros

query

string | undefined

setQueryParameter(string, unknown)

Defina um parâmetro de consulta com o nome e o valor fornecidos na consulta dessa URL. Se o valor do parâmetro de consulta fornecido estiver indefinido ou vazio, o parâmetro de consulta será removido se existir.

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

Parâmetros

queryParameterName

string

queryParameterValue

unknown

setScheme(string | undefined)

Defina o esquema/protocolo para essa URL. Se o esquema fornecido contiver outras partes de uma URL (como um host, porta, caminho ou consulta), essas partes também serão adicionadas a essa URL.

function setScheme(scheme: string | undefined)

Parâmetros

scheme

string | undefined

toString()

Serializa a URL como uma cadeia de caracteres.

function toString(): string

Retornos

string

a URL como uma cadeia de caracteres.