URLBuilder class

Pacote:

@azure/ms-rest-js

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

Métodos

appendPath(undefined | string)	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)
replaceAll(string, string)	Se o searchValue fornecido for encontrado neste URLBuilder, substitua-o pelo replaceValue fornecido.
setHost(undefined | string)	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(undefined | string)	Defina o caminho para essa URL. Se o caminho fornecido contiver uma consulta, ele também será adicionado a essa URL.
setPort(undefined | string | number)	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(undefined | string)	Defina a consulta nesta URL.
setQueryParameter(string, any)	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(undefined | string)	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()

Detalhes do método

appendPath(undefined | string)

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: undefined | string)

Parâmetros

path

undefined | string

getHost()

Obtenha o host que foi definido nesta URL.

function getHost(): undefined | string

Retornos

undefined | string

getPath()

Obtenha o caminho que foi definido nesta URL.

function getPath(): undefined | string

Retornos

undefined | string

getPort()

Obtenha a porta que foi definida nesta URL.

function getPort(): undefined | string

Retornos

undefined | string

getQuery()

Obtenha a consulta nesta URL.

function getQuery(): undefined | string

Retornos

undefined | string

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): undefined | string | string[]

Parâmetros

queryParameterName

string

Retornos

undefined | string | string[]

getScheme()

Obtenha o esquema que foi definido nesta URL.

function getScheme(): undefined | string

Retornos

undefined | string

parse(string)

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(undefined | string)

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: undefined | string)

Parâmetros

host

undefined | string

setPath(undefined | string)

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

function setPath(path: undefined | string)

Parâmetros

path

undefined | string

setPort(undefined | string | number)

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: undefined | string | number)

Parâmetros

port

undefined | string | number

setQuery(undefined | string)

Defina a consulta nesta URL.

function setQuery(query: undefined | string)

Parâmetros

query

undefined | string

setQueryParameter(string, any)

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: any)

Parâmetros

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

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: undefined | string)

Parâmetros

scheme

undefined | string

toString()

function toString(): string

Retornos

string