URLBuilder class

Balíček:

@azure/ms-rest-js

Třída, která zpracovává vytváření, úpravy a parsování adres URL.

Metody

appendPath(undefined | string)	Připojte zadanou cestu k existující cestě této adresy URL. Pokud zadaná cesta obsahuje dotaz, přidá se také na tuto adresu URL.
getHost()	Získejte hostitele, který byl nastaven v této adrese URL.
getPath()	Získá cestu nastavenou v této adrese URL.
getPort()	Získejte port nastavený v této adrese URL.
getQuery()	Získejte dotaz v této adrese URL.
getQueryParameterValue(string)	Získejte hodnotu parametru dotazu se zadaným názvem parametru dotazu. Pokud neexistuje žádný parametr dotazu se zadaným názvem, vrátí se nedefinovaný parametr .
getScheme()	Získejte schéma, které bylo nastaveno v této adrese URL.
parse(string)
replaceAll(string, string)	Pokud je v tomto modulu URLBuilder nalezena hodnota searchValue, nahraďte ji za poskytnutou hodnotu replaceValue.
setHost(undefined | string)	Nastavte hostitele pro tuto adresu URL. Pokud zadaný hostitel obsahuje další části adresy URL (například port, cestu nebo dotaz), přidají se do této adresy URL také tyto části.
setPath(undefined | string)	Nastavte cestu pro tuto adresu URL. Pokud zadaná cesta obsahuje dotaz, přidá se také na tuto adresu URL.
setPort(undefined | string | number)	Nastavte port pro tuto adresu URL. Pokud zadaný port obsahuje jiné části adresy URL (například cestu nebo dotaz), přidají se do této adresy URL také tyto části.
setQuery(undefined | string)	Nastavte dotaz v této adrese URL.
setQueryParameter(string, any)	Nastavte parametr dotazu se zadaným názvem a hodnotou v dotazu této adresy URL. Pokud je zadaná hodnota parametru dotazu nedefinovaná nebo prázdná, odebere se parametr dotazu, pokud existoval.
setScheme(undefined | string)	Nastavte schéma nebo protokol pro tuto adresu URL. Pokud zadané schéma obsahuje další části adresy URL (například hostitele, port, cestu nebo dotaz), přidají se do této adresy URL také tyto části.
toString()

Podrobnosti metody

appendPath(undefined | string)

Připojte zadanou cestu k existující cestě této adresy URL. Pokud zadaná cesta obsahuje dotaz, přidá se také na tuto adresu URL.

function appendPath(path: undefined | string)

Parametry

path

undefined | string

getHost()

Získejte hostitele, který byl nastaven v této adrese URL.

function getHost(): undefined | string

Návraty

undefined | string

getPath()

Získá cestu nastavenou v této adrese URL.

function getPath(): undefined | string

Návraty

undefined | string

getPort()

Získejte port nastavený v této adrese URL.

function getPort(): undefined | string

Návraty

undefined | string

getQuery()

Získejte dotaz v této adrese URL.

function getQuery(): undefined | string

Návraty

undefined | string

getQueryParameterValue(string)

Získejte hodnotu parametru dotazu se zadaným názvem parametru dotazu. Pokud neexistuje žádný parametr dotazu se zadaným názvem, vrátí se nedefinovaný parametr .

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

Parametry

queryParameterName

string

Návraty

undefined | string | string[]

getScheme()

Získejte schéma, které bylo nastaveno v této adrese URL.

function getScheme(): undefined | string

Návraty

undefined | string

parse(string)

static function parse(text: string): URLBuilder

Parametry

text

string

Návraty

URLBuilder

replaceAll(string, string)

Pokud je v tomto modulu URLBuilder nalezena hodnota searchValue, nahraďte ji za poskytnutou hodnotu replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parametry

searchValue

string

replaceValue

string

setHost(undefined | string)

Nastavte hostitele pro tuto adresu URL. Pokud zadaný hostitel obsahuje další části adresy URL (například port, cestu nebo dotaz), přidají se do této adresy URL také tyto části.

function setHost(host: undefined | string)

Parametry

host

undefined | string

setPath(undefined | string)

Nastavte cestu pro tuto adresu URL. Pokud zadaná cesta obsahuje dotaz, přidá se také na tuto adresu URL.

function setPath(path: undefined | string)

Parametry

path

undefined | string

setPort(undefined | string | number)

Nastavte port pro tuto adresu URL. Pokud zadaný port obsahuje jiné části adresy URL (například cestu nebo dotaz), přidají se do této adresy URL také tyto části.

function setPort(port: undefined | string | number)

Parametry

port

undefined | string | number

setQuery(undefined | string)

Nastavte dotaz v této adrese URL.

function setQuery(query: undefined | string)

Parametry

query

undefined | string

setQueryParameter(string, any)

Nastavte parametr dotazu se zadaným názvem a hodnotou v dotazu této adresy URL. Pokud je zadaná hodnota parametru dotazu nedefinovaná nebo prázdná, odebere se parametr dotazu, pokud existoval.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Parametry

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

Nastavte schéma nebo protokol pro tuto adresu URL. Pokud zadané schéma obsahuje další části adresy URL (například hostitele, port, cestu nebo dotaz), přidají se do této adresy URL také tyto části.

function setScheme(scheme: undefined | string)

Parametry

scheme

undefined | string

toString()

function toString(): string

Návraty

string