URLBuilder class

Paket:

@azure/core-http

Eine Klasse, die das Erstellen, Ändern und Analysieren von URLs behandelt.

Methoden

appendPath(undefined | string)	Fügen Sie den angegebenen Pfad an den vorhandenen Pfad dieser URL an. Wenn der angegebene Pfad eine Abfrage enthält, wird er auch dieser URL hinzugefügt.
getHost()	Rufen Sie den Host ab, der in dieser URL festgelegt wurde.
getPath()	Rufen Sie den Pfad ab, der in dieser URL festgelegt wurde.
getPort()	Rufen Sie den Port ab, der in dieser URL festgelegt wurde.
getQuery()	Rufen Sie die Abfrage in dieser URL ab.
getQueryParameterValue(string)	Rufen Sie den Wert des Abfrageparameters mit dem angegebenen Abfrageparameternamen ab. Wenn kein Abfrageparameter mit dem angegebenen Namen vorhanden ist, wird undefined zurückgegeben.
getScheme()	Rufen Sie das Schema ab, das in dieser URL festgelegt wurde.
parse(string)	Analysiert eine angegebene Zeichenfolgen-URL in einen neuen URLBuilder.
replaceAll(string, string)	Wenn der bereitgestellte searchValue in diesem URLBuilder gefunden wird, ersetzen Sie ihn durch den bereitgestellten replaceValue.
setHost(undefined | string)	Legen Sie den Host für diese URL fest. Wenn der bereitgestellte Host andere Teile einer URL enthält (z. B. einen Port, Pfad oder eine Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.
setPath(undefined | string)	Legen Sie den Pfad für diese URL fest. Wenn der angegebene Pfad eine Abfrage enthält, wird er auch dieser URL hinzugefügt.
setPort(undefined | string | number)	Legen Sie den Port für diese URL fest. Wenn der bereitgestellte Port andere Teile einer URL enthält (z. B. einen Pfad oder eine Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.
setQuery(undefined | string)	Legen Sie die Abfrage in dieser URL fest.
setQueryParameter(string, unknown)	Legen Sie einen Abfrageparameter mit dem angegebenen Namen und Wert in der Abfrage dieser URL fest. Wenn der angegebene Abfrageparameterwert nicht definiert oder leer ist, wird der Abfrageparameter entfernt, wenn er vorhanden ist.
setScheme(undefined | string)	Legen Sie das Schema/Protokoll für diese URL fest. Wenn das bereitgestellte Schema andere Teile einer URL enthält (z. B. Host, Port, Pfad oder Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.
toString()	Serialisiert die URL als Zeichenfolge.

Details zur Methode

appendPath(undefined | string)

Fügen Sie den angegebenen Pfad an den vorhandenen Pfad dieser URL an. Wenn der angegebene Pfad eine Abfrage enthält, wird er auch dieser URL hinzugefügt.

function appendPath(path: undefined | string)

Parameter

path

undefined | string

getHost()

Rufen Sie den Host ab, der in dieser URL festgelegt wurde.

function getHost(): undefined | string

Gibt zurück

undefined | string

getPath()

Rufen Sie den Pfad ab, der in dieser URL festgelegt wurde.

function getPath(): undefined | string

Gibt zurück

undefined | string

getPort()

Rufen Sie den Port ab, der in dieser URL festgelegt wurde.

function getPort(): undefined | string

Gibt zurück

undefined | string

getQuery()

Rufen Sie die Abfrage in dieser URL ab.

function getQuery(): undefined | string

Gibt zurück

undefined | string

getQueryParameterValue(string)

Rufen Sie den Wert des Abfrageparameters mit dem angegebenen Abfrageparameternamen ab. Wenn kein Abfrageparameter mit dem angegebenen Namen vorhanden ist, wird undefined zurückgegeben.

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

Parameter

queryParameterName

string

Gibt zurück

undefined | string | string[]

getScheme()

Rufen Sie das Schema ab, das in dieser URL festgelegt wurde.

function getScheme(): undefined | string

Gibt zurück

undefined | string

parse(string)

Analysiert eine angegebene Zeichenfolgen-URL in einen neuen URLBuilder.

static function parse(text: string): URLBuilder

Parameter

text

string

Gibt zurück

URLBuilder

replaceAll(string, string)

Wenn der bereitgestellte searchValue in diesem URLBuilder gefunden wird, ersetzen Sie ihn durch den bereitgestellten replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parameter

searchValue

string

replaceValue

string

setHost(undefined | string)

Legen Sie den Host für diese URL fest. Wenn der bereitgestellte Host andere Teile einer URL enthält (z. B. einen Port, Pfad oder eine Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.

function setHost(host: undefined | string)

Parameter

host

undefined | string

setPath(undefined | string)

Legen Sie den Pfad für diese URL fest. Wenn der angegebene Pfad eine Abfrage enthält, wird er auch dieser URL hinzugefügt.

function setPath(path: undefined | string)

Parameter

path

undefined | string

setPort(undefined | string | number)

Legen Sie den Port für diese URL fest. Wenn der bereitgestellte Port andere Teile einer URL enthält (z. B. einen Pfad oder eine Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.

function setPort(port: undefined | string | number)

Parameter

port

undefined | string | number

setQuery(undefined | string)

Legen Sie die Abfrage in dieser URL fest.

function setQuery(query: undefined | string)

Parameter

query

undefined | string

setQueryParameter(string, unknown)

Legen Sie einen Abfrageparameter mit dem angegebenen Namen und Wert in der Abfrage dieser URL fest. Wenn der angegebene Abfrageparameterwert nicht definiert oder leer ist, wird der Abfrageparameter entfernt, wenn er vorhanden ist.

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

Parameter

queryParameterName

string

queryParameterValue

unknown

setScheme(undefined | string)

Legen Sie das Schema/Protokoll für diese URL fest. Wenn das bereitgestellte Schema andere Teile einer URL enthält (z. B. Host, Port, Pfad oder Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.

function setScheme(scheme: undefined | string)

Parameter

scheme

undefined | string

toString()

Serialisiert die URL als Zeichenfolge.

function toString(): string

Gibt zurück

string

die URL als Zeichenfolge.