URLBuilder class

Balíček:

@azure/ms-rest-js

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

Metody

appendPath(string | undefined)	Připojte zadanou cestu k existující cestě této adresy URL. Pokud zadaná cesta obsahuje dotaz, přidá se také do této adresy URL.
getHost()	Získejte hostitele, který je nastavený v této adrese URL.
getPath()	Získejte cestu, která byla nastavena 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íská hodnotu parametru dotazu s zadaným názvem parametru dotazu. Pokud s zadaným názvem neexistuje žádný parametr dotazu, vrátí se nedefinovaný parametr.
getScheme()	Získejte schéma nastavené v této adrese URL.
parse(string)
replaceAll(string, string)	Pokud se zadaný searchValue najde v tomto urlBuilderu, pak ho nahraďte zadanou hodnotu replaceValue.
setHost(string | undefined)	Nastavte hostitele pro tuto adresu URL. Pokud zadaný hostitel obsahuje další části adresy URL (například port, cestu nebo dotaz), tyto části se také přidají do této adresy URL.
setPath(string | undefined)	Nastavte cestu pro tuto adresu URL. Pokud zadaná cesta obsahuje dotaz, přidá se také do této adresy URL.
setPort(string | number | undefined)	Nastavte port pro tuto adresu URL. Pokud zadaný port obsahuje další části adresy URL (například cestu nebo dotaz), tyto části se také přidají do této adresy URL.
setQuery(string | undefined)	Nastavte dotaz v této adrese URL.
setQueryParameter(string, any)	Nastavte parametr dotazu s zadaným názvem a hodnotou v dotazu této adresy URL. Pokud je zadaná hodnota parametru dotazu nedefinovaná nebo prázdná, parametr dotazu se odebere, pokud existoval.
setScheme(string | undefined)	Nastavte schéma/protokol pro tuto adresu URL. Pokud zadané schéma obsahuje další části adresy URL (například hostitele, port, cestu nebo dotaz), tyto části se také přidají do této adresy URL.
toString()

Podrobnosti metody

appendPath(string | undefined)

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

function appendPath(path: string | undefined)

Parametry

path

string | undefined

getHost()

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

function getHost(): string | undefined

Návraty

string | undefined

getPath()

Získejte cestu, která byla nastavena v této adrese URL.

function getPath(): string | undefined

Návraty

string | undefined

getPort()

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

function getPort(): string | undefined

Návraty

string | undefined

getQuery()

Získejte dotaz v této adrese URL.

function getQuery(): string | undefined

Návraty

string | undefined

getQueryParameterValue(string)

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

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

Parametry

queryParameterName

string

Návraty

string | string[] | undefined

getScheme()

Získejte schéma nastavené v této adrese URL.

function getScheme(): string | undefined

Návraty

string | undefined

parse(string)

static function parse(text: string): URLBuilder

Parametry

text

string

Návraty

URLBuilder

replaceAll(string, string)

Pokud se zadaný searchValue najde v tomto urlBuilderu, pak ho nahraďte zadanou hodnotu replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parametry

searchValue

string

replaceValue

string

setHost(string | undefined)

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

function setHost(host: string | undefined)

Parametry

host

string | undefined

setPath(string | undefined)

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

function setPath(path: string | undefined)

Parametry

path

string | undefined

setPort(string | number | undefined)

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

function setPort(port: string | number | undefined)

Parametry

port

string | number | undefined

setQuery(string | undefined)

Nastavte dotaz v této adrese URL.

function setQuery(query: string | undefined)

Parametry

query

string | undefined

setQueryParameter(string, any)

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

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Parametry

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

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

function setScheme(scheme: string | undefined)

Parametry

scheme

string | undefined

toString()

function toString(): string

Návraty

string