URLBuilder class

Pakket:

@azure/core-http

Een klasse die URL's maakt, wijzigt en parseert.

Methoden

appendPath(undefined | string)	Voeg het opgegeven pad toe aan het bestaande pad van deze URL. Als het opgegeven pad een query bevat, wordt deze ook aan deze URL toegevoegd.
getHost()	Haal de host op die is ingesteld in deze URL.
getPath()	Haal het pad op dat is ingesteld in deze URL.
getPort()	Haal de poort op die is ingesteld in deze URL.
getQuery()	Haal de query op in deze URL.
getQueryParameterValue(string)	Haal de waarde van de queryparameter op met de opgegeven naam van de queryparameter. Als er geen queryparameter met de opgegeven naam bestaat, wordt niet-gedefinieerd geretourneerd.
getScheme()	Haal het schema op dat is ingesteld in deze URL.
parse(string)	Parseert een bepaalde tekenreeks-URL in een nieuwe URLBuilder.
replaceAll(string, string)	Als de opgegeven searchValue wordt gevonden in deze URLBuilder, vervangt u deze door de opgegeven replaceValue.
setHost(undefined | string)	Stel de host voor deze URL in. Als de opgegeven host andere onderdelen van een URL bevat (zoals een poort, pad of query), worden deze onderdelen ook aan deze URL toegevoegd.
setPath(undefined | string)	Stel het pad voor deze URL in. Als het opgegeven pad een query bevat, wordt deze ook aan deze URL toegevoegd.
setPort(undefined | string | number)	Stel de poort voor deze URL in. Als de opgegeven poort andere delen van een URL bevat (zoals een pad of query), worden die onderdelen ook aan deze URL toegevoegd.
setQuery(undefined | string)	Stel de query in deze URL in.
setQueryParameter(string, unknown)	Stel een queryparameter in met de opgegeven naam en waarde in de query van deze URL. Als de opgegeven queryparameterwaarde niet gedefinieerd of leeg is, wordt de queryparameter verwijderd als deze bestaat.
setScheme(undefined | string)	Stel het schema/protocol voor deze URL in. Als het opgegeven schema andere onderdelen van een URL bevat (zoals een host, poort, pad of query), worden deze onderdelen ook aan deze URL toegevoegd.
toString()	Serialiseert de URL als een tekenreeks.

Methodedetails

appendPath(undefined | string)

Voeg het opgegeven pad toe aan het bestaande pad van deze URL. Als het opgegeven pad een query bevat, wordt deze ook aan deze URL toegevoegd.

function appendPath(path: undefined | string)

Parameters

path

undefined | string

getHost()

Haal de host op die is ingesteld in deze URL.

function getHost(): undefined | string

Retouren

undefined | string

getPath()

Haal het pad op dat is ingesteld in deze URL.

function getPath(): undefined | string

Retouren

undefined | string

getPort()

Haal de poort op die is ingesteld in deze URL.

function getPort(): undefined | string

Retouren

undefined | string

getQuery()

Haal de query op in deze URL.

function getQuery(): undefined | string

Retouren

undefined | string

getQueryParameterValue(string)

Haal de waarde van de queryparameter op met de opgegeven naam van de queryparameter. Als er geen queryparameter met de opgegeven naam bestaat, wordt niet-gedefinieerd geretourneerd.

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

Parameters

queryParameterName

string

Retouren

undefined | string | string[]

getScheme()

Haal het schema op dat is ingesteld in deze URL.

function getScheme(): undefined | string

Retouren

undefined | string

parse(string)

Parseert een bepaalde tekenreeks-URL in een nieuwe URLBuilder.

static function parse(text: string): URLBuilder

Parameters

text

string

Retouren

URLBuilder

replaceAll(string, string)

Als de opgegeven searchValue wordt gevonden in deze URLBuilder, vervangt u deze door de opgegeven replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parameters

searchValue

string

replaceValue

string

setHost(undefined | string)

Stel de host voor deze URL in. Als de opgegeven host andere onderdelen van een URL bevat (zoals een poort, pad of query), worden deze onderdelen ook aan deze URL toegevoegd.

function setHost(host: undefined | string)

Parameters

host

undefined | string

setPath(undefined | string)

Stel het pad voor deze URL in. Als het opgegeven pad een query bevat, wordt deze ook aan deze URL toegevoegd.

function setPath(path: undefined | string)

Parameters

path

undefined | string

setPort(undefined | string | number)

Stel de poort voor deze URL in. Als de opgegeven poort andere delen van een URL bevat (zoals een pad of query), worden die onderdelen ook aan deze URL toegevoegd.

function setPort(port: undefined | string | number)

Parameters

port

undefined | string | number

setQuery(undefined | string)

Stel de query in deze URL in.

function setQuery(query: undefined | string)

Parameters

query

undefined | string

setQueryParameter(string, unknown)

Stel een queryparameter in met de opgegeven naam en waarde in de query van deze URL. Als de opgegeven queryparameterwaarde niet gedefinieerd of leeg is, wordt de queryparameter verwijderd als deze bestaat.

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

Parameters

queryParameterName

string

queryParameterValue

unknown

setScheme(undefined | string)

Stel het schema/protocol voor deze URL in. Als het opgegeven schema andere onderdelen van een URL bevat (zoals een host, poort, pad of query), worden deze onderdelen ook aan deze URL toegevoegd.

function setScheme(scheme: undefined | string)

Parameters

scheme

undefined | string

toString()

Serialiseert de URL als een tekenreeks.

function toString(): string

Retouren

string

de URL als een tekenreeks.