URLBuilder class

Paquete:

@azure/ms-rest-js

Clase que controla la creación, modificación y análisis de direcciones URL.

Métodos

appendPath(undefined | string)	Anexe la ruta de acceso proporcionada a la ruta de acceso existente de esta dirección URL. Si la ruta de acceso proporcionada contiene una consulta, también se agregará a esta dirección URL.
getHost()	Obtenga el host que se ha establecido en esta dirección URL.
getPath()	Obtenga la ruta de acceso que se ha establecido en esta dirección URL.
getPort()	Obtenga el puerto que se ha establecido en esta dirección URL.
getQuery()	Obtenga la consulta en esta dirección URL.
getQueryParameterValue(string)	Obtenga el valor del parámetro de consulta con el nombre del parámetro de consulta proporcionado. Si no existe ningún parámetro de consulta con el nombre proporcionado, se devolverá undefined.
getScheme()	Obtenga el esquema que se ha establecido en esta dirección URL.
parse(string)
replaceAll(string, string)	Si el elemento searchValue proporcionado se encuentra en este urlBuilder, reemplácelo por el valor replaceValue proporcionado.
setHost(undefined | string)	Establezca el host para esta dirección URL. Si el host proporcionado contiene otras partes de una dirección URL (como un puerto, una ruta de acceso o una consulta), esos elementos también se agregarán a esta dirección URL.
setPath(undefined | string)	Establezca la ruta de acceso de esta dirección URL. Si la ruta de acceso proporcionada contiene una consulta, también se agregará a esta dirección URL.
setPort(undefined | string | number)	Establezca el puerto para esta dirección URL. Si el puerto proporcionado contiene otras partes de una dirección URL (como una ruta de acceso o consulta), también se agregarán a esta dirección URL.
setQuery(undefined | string)	Establezca la consulta en esta dirección URL.
setQueryParameter(string, any)	Establezca un parámetro de consulta con el nombre y el valor proporcionados en la consulta de esta dirección URL. Si el valor del parámetro de consulta proporcionado no está definido o está vacío, el parámetro de consulta se quitará si existía.
setScheme(undefined | string)	Establezca el esquema o protocolo para esta dirección URL. Si el esquema proporcionado contiene otras partes de una dirección URL (como un host, puerto, ruta de acceso o consulta), esos elementos también se agregarán a esta dirección URL.
toString()

Detalles del método

appendPath(undefined | string)

Anexe la ruta de acceso proporcionada a la ruta de acceso existente de esta dirección URL. Si la ruta de acceso proporcionada contiene una consulta, también se agregará a esta dirección URL.

function appendPath(path: undefined | string)

Parámetros

path

undefined | string

getHost()

Obtenga el host que se ha establecido en esta dirección URL.

function getHost(): undefined | string

Devoluciones

undefined | string

getPath()

Obtenga la ruta de acceso que se ha establecido en esta dirección URL.

function getPath(): undefined | string

Devoluciones

undefined | string

getPort()

Obtenga el puerto que se ha establecido en esta dirección URL.

function getPort(): undefined | string

Devoluciones

undefined | string

getQuery()

Obtenga la consulta en esta dirección URL.

function getQuery(): undefined | string

Devoluciones

undefined | string

getQueryParameterValue(string)

Obtenga el valor del parámetro de consulta con el nombre del parámetro de consulta proporcionado. Si no existe ningún parámetro de consulta con el nombre proporcionado, se devolverá undefined.

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

Parámetros

queryParameterName

string

Devoluciones

undefined | string | string[]

getScheme()

Obtenga el esquema que se ha establecido en esta dirección URL.

function getScheme(): undefined | string

Devoluciones

undefined | string

parse(string)

static function parse(text: string): URLBuilder

Parámetros

text

string

Devoluciones

URLBuilder

replaceAll(string, string)

Si el elemento searchValue proporcionado se encuentra en este urlBuilder, reemplácelo por el valor replaceValue proporcionado.

function replaceAll(searchValue: string, replaceValue: string)

Parámetros

searchValue

string

replaceValue

string

setHost(undefined | string)

Establezca el host para esta dirección URL. Si el host proporcionado contiene otras partes de una dirección URL (como un puerto, una ruta de acceso o una consulta), esos elementos también se agregarán a esta dirección URL.

function setHost(host: undefined | string)

Parámetros

host

undefined | string

setPath(undefined | string)

Establezca la ruta de acceso de esta dirección URL. Si la ruta de acceso proporcionada contiene una consulta, también se agregará a esta dirección URL.

function setPath(path: undefined | string)

Parámetros

path

undefined | string

setPort(undefined | string | number)

Establezca el puerto para esta dirección URL. Si el puerto proporcionado contiene otras partes de una dirección URL (como una ruta de acceso o consulta), también se agregarán a esta dirección URL.

function setPort(port: undefined | string | number)

Parámetros

port

undefined | string | number

setQuery(undefined | string)

Establezca la consulta en esta dirección URL.

function setQuery(query: undefined | string)

Parámetros

query

undefined | string

setQueryParameter(string, any)

Establezca un parámetro de consulta con el nombre y el valor proporcionados en la consulta de esta dirección URL. Si el valor del parámetro de consulta proporcionado no está definido o está vacío, el parámetro de consulta se quitará si existía.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Parámetros

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

Establezca el esquema o protocolo para esta dirección URL. Si el esquema proporcionado contiene otras partes de una dirección URL (como un host, puerto, ruta de acceso o consulta), esos elementos también se agregarán a esta dirección URL.

function setScheme(scheme: undefined | string)

Parámetros

scheme

undefined | string

toString()

function toString(): string

Devoluciones

string