URLBuilder class

Pakiet:

@azure/core-http

Klasa, która obsługuje tworzenie, modyfikowanie i analizowanie adresów URL.

Metody

appendPath(undefined | string)	Dołącz podaną ścieżkę do istniejącej ścieżki tego adresu URL. Jeśli podana ścieżka zawiera zapytanie, zostanie również dodana do tego adresu URL.
getHost()	Pobierz hosta, który został ustawiony w tym adresie URL.
getPath()	Pobierz ścieżkę ustawioną w tym adresie URL.
getPort()	Pobierz port ustawiony w tym adresie URL.
getQuery()	Pobierz zapytanie w tym adresie URL.
getQueryParameterValue(string)	Pobierz wartość parametru zapytania z podaną nazwą parametru zapytania. Jeśli nie istnieje parametr zapytania o podanej nazwie, zostanie zwrócony niezdefiniowany.
getScheme()	Pobierz schemat ustawiony w tym adresie URL.
parse(string)	Analizuje dany adres URL ciągu w nowym obiekcie URLBuilder.
replaceAll(string, string)	Jeśli podana wartość searchValue zostanie znaleziona w tym urlBuilder, zastąp ją podaną wartością replaceValue.
setHost(undefined | string)	Ustaw hosta dla tego adresu URL. Jeśli podany host zawiera inne części adresu URL (takie jak port, ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.
setPath(undefined | string)	Ustaw ścieżkę dla tego adresu URL. Jeśli podana ścieżka zawiera zapytanie, zostanie również dodana do tego adresu URL.
setPort(undefined | string | number)	Ustaw port dla tego adresu URL. Jeśli podany port zawiera inne części adresu URL (takie jak ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.
setQuery(undefined | string)	Ustaw zapytanie w tym adresie URL.
setQueryParameter(string, unknown)	Ustaw parametr zapytania z podaną nazwą i wartością w zapytaniu tego adresu URL. Jeśli podana wartość parametru zapytania jest niezdefiniowana lub pusta, parametr zapytania zostanie usunięty, jeśli istnieje.
setScheme(undefined | string)	Ustaw schemat/protokół dla tego adresu URL. Jeśli podany schemat zawiera inne części adresu URL (takie jak host, port, ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.
toString()	Serializuje adres URL jako ciąg.

Szczegóły metody

appendPath(undefined | string)

Dołącz podaną ścieżkę do istniejącej ścieżki tego adresu URL. Jeśli podana ścieżka zawiera zapytanie, zostanie również dodana do tego adresu URL.

function appendPath(path: undefined | string)

Parametry

path

undefined | string

getHost()

Pobierz hosta, który został ustawiony w tym adresie URL.

function getHost(): undefined | string

Zwraca

undefined | string

getPath()

Pobierz ścieżkę ustawioną w tym adresie URL.

function getPath(): undefined | string

Zwraca

undefined | string

getPort()

Pobierz port ustawiony w tym adresie URL.

function getPort(): undefined | string

Zwraca

undefined | string

getQuery()

Pobierz zapytanie w tym adresie URL.

function getQuery(): undefined | string

Zwraca

undefined | string

getQueryParameterValue(string)

Pobierz wartość parametru zapytania z podaną nazwą parametru zapytania. Jeśli nie istnieje parametr zapytania o podanej nazwie, zostanie zwrócony niezdefiniowany.

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

Parametry

queryParameterName

string

Zwraca

undefined | string | string[]

getScheme()

Pobierz schemat ustawiony w tym adresie URL.

function getScheme(): undefined | string

Zwraca

undefined | string

parse(string)

Analizuje dany adres URL ciągu w nowym obiekcie URLBuilder.

static function parse(text: string): URLBuilder

Parametry

text

string

Zwraca

URLBuilder

replaceAll(string, string)

Jeśli podana wartość searchValue zostanie znaleziona w tym urlBuilder, zastąp ją podaną wartością replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parametry

searchValue

string

replaceValue

string

setHost(undefined | string)

Ustaw hosta dla tego adresu URL. Jeśli podany host zawiera inne części adresu URL (takie jak port, ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.

function setHost(host: undefined | string)

Parametry

host

undefined | string

setPath(undefined | string)

Ustaw ścieżkę dla tego adresu URL. Jeśli podana ścieżka zawiera zapytanie, zostanie również dodana do tego adresu URL.

function setPath(path: undefined | string)

Parametry

path

undefined | string

setPort(undefined | string | number)

Ustaw port dla tego adresu URL. Jeśli podany port zawiera inne części adresu URL (takie jak ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.

function setPort(port: undefined | string | number)

Parametry

port

undefined | string | number

setQuery(undefined | string)

Ustaw zapytanie w tym adresie URL.

function setQuery(query: undefined | string)

Parametry

query

undefined | string

setQueryParameter(string, unknown)

Ustaw parametr zapytania z podaną nazwą i wartością w zapytaniu tego adresu URL. Jeśli podana wartość parametru zapytania jest niezdefiniowana lub pusta, parametr zapytania zostanie usunięty, jeśli istnieje.

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

Parametry

queryParameterName

string

queryParameterValue

unknown

setScheme(undefined | string)

Ustaw schemat/protokół dla tego adresu URL. Jeśli podany schemat zawiera inne części adresu URL (takie jak host, port, ścieżka lub zapytanie), te części również zostaną dodane do tego adresu URL.

function setScheme(scheme: undefined | string)

Parametry

scheme

undefined | string

toString()

Serializuje adres URL jako ciąg.

function toString(): string

Zwraca

string

adres URL jako ciąg.