URLBuilder class

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

Métodos

appendPath(string | undefined)

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 valor searchValue proporcionado se encuentra en este urlBuilder, reemplácelo por el valor replaceValue proporcionado.

setHost(string | undefined)

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

setPath(string | undefined)

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

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), esas partes también se agregarán a esta dirección URL.

setQuery(string | undefined)

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

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

toString()

Detalles del método

appendPath(string | undefined)

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

Parámetros

path

string | undefined

getHost()

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

function getHost(): string | undefined

Devoluciones

string | undefined

getPath()

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

function getPath(): string | undefined

Devoluciones

string | undefined

getPort()

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

function getPort(): string | undefined

Devoluciones

string | undefined

getQuery()

Obtenga la consulta en esta dirección URL.

function getQuery(): string | undefined

Devoluciones

string | undefined

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

Parámetros

queryParameterName

string

Devoluciones

string | string[] | undefined

getScheme()

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

function getScheme(): string | undefined

Devoluciones

string | undefined

parse(string)

static function parse(text: string): URLBuilder

Parámetros

text

string

Devoluciones

replaceAll(string, string)

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

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

function setHost(host: string | undefined)

Parámetros

host

string | undefined

setPath(string | undefined)

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

Parámetros

path

string | undefined

setPort(string | number | undefined)

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), esas partes también se agregarán a esta dirección URL.

function setPort(port: string | number | undefined)

Parámetros

port

string | number | undefined

setQuery(string | undefined)

Establezca la consulta en esta dirección URL.

function setQuery(query: string | undefined)

Parámetros

query

string | undefined

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

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

function setScheme(scheme: string | undefined)

Parámetros

scheme

string | undefined

toString()

function toString(): string

Devoluciones

string