URLBuilder class

Paket:

@azure/ms-rest-js

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

Methoden

appendPath(string | undefined)	Fügen Sie den bereitgestellten 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 undefiniert zurückgegeben.
getScheme()	Rufen Sie das Schema ab, das in dieser URL festgelegt wurde.
parse(string)
replaceAll(string, string)	Wenn der bereitgestellte searchValue in diesem URLBuilder gefunden wird, ersetzen Sie ihn durch den bereitgestellten replaceValue.
setHost(string | undefined)	Legen Sie den Host für diese URL fest. Wenn der bereitgestellte Host andere Teile einer URL enthält (z. B. Port, Pfad oder Abfrage), werden diese Teile ebenfalls dieser URL hinzugefügt.
setPath(string | undefined)	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(string | number | undefined)	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(string | undefined)	Legen Sie die Abfrage in dieser URL fest.
setQueryParameter(string, any)	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(string | undefined)	Legen Sie das Schema/Protokoll für diese URL fest. Wenn das bereitgestellte Schema andere Teile einer URL (z. B. Host, Port, Pfad oder Abfrage) enthält, werden diese Teile ebenfalls dieser URL hinzugefügt.
toString()

Details zur Methode

appendPath(string | undefined)

Fügen Sie den bereitgestellten 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: string | undefined)

Parameter

path

string | undefined

getHost()

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

function getHost(): string | undefined

Gibt zurück

string | undefined

getPath()

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

function getPath(): string | undefined

Gibt zurück

string | undefined

getPort()

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

function getPort(): string | undefined

Gibt zurück

string | undefined

getQuery()

Rufen Sie die Abfrage in dieser URL ab.

function getQuery(): string | undefined

Gibt zurück

string | undefined

getQueryParameterValue(string)

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

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

Parameter

queryParameterName

string

Gibt zurück

string | string[] | undefined

getScheme()

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

function getScheme(): string | undefined

Gibt zurück

string | undefined

parse(string)

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

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

function setHost(host: string | undefined)

Parameter

host

string | undefined

setPath(string | undefined)

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

Parameter

path

string | undefined

setPort(string | number | undefined)

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

Parameter

port

string | number | undefined

setQuery(string | undefined)

Legen Sie die Abfrage in dieser URL fest.

function setQuery(query: string | undefined)

Parameter

query

string | undefined

setQueryParameter(string, any)

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: any)

Parameter

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

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

function setScheme(scheme: string | undefined)

Parameter

scheme

string | undefined

toString()

function toString(): string

Gibt zurück

string