URLBuilder class

Pakket:

@azure/ms-rest-js

Een klasse die het maken, wijzigen en parseren van URL's afhandelt.

Methoden

appendPath(string | undefined)	Voeg het opgegeven pad toe aan het bestaande pad van deze URL. Als het opgegeven pad een query bevat, wordt het ook toegevoegd aan deze URL.
getHost()	Haal de host op die in deze URL is ingesteld.
getPath()	Haal het pad op dat is ingesteld in deze URL.
getPort()	Haal de poort op die in deze URL is ingesteld.
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 bestaat met de opgegeven naam, wordt niet gedefinieerd geretourneerd.
getScheme()	Haal het schema op dat in deze URL is ingesteld.
parse(string)
replaceAll(string, string)	Als de opgegeven searchValue wordt gevonden in deze URLBuilder, vervangt u deze door de opgegeven replaceValue.
setHost(string | undefined)	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(string | undefined)	Stel het pad voor deze URL in. Als het opgegeven pad een query bevat, wordt het ook toegevoegd aan deze URL.
setPort(string | number | undefined)	Stel de poort voor deze URL in. Als de opgegeven poort andere delen van een URL (zoals een pad of query) bevat, worden deze onderdelen ook aan deze URL toegevoegd.
setQuery(string | undefined)	Stel de query in deze URL in.
setQueryParameter(string, any)	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(string | undefined)	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()

Methodedetails

appendPath(string | undefined)

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

function appendPath(path: string | undefined)

Parameters

path

string | undefined

getHost()

Haal de host op die in deze URL is ingesteld.

function getHost(): string | undefined

Retouren

string | undefined

getPath()

Haal het pad op dat is ingesteld in deze URL.

function getPath(): string | undefined

Retouren

string | undefined

getPort()

Haal de poort op die in deze URL is ingesteld.

function getPort(): string | undefined

Retouren

string | undefined

getQuery()

Haal de query op in deze URL.

function getQuery(): string | undefined

Retouren

string | undefined

getQueryParameterValue(string)

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

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

Parameters

queryParameterName

string

Retouren

string | string[] | undefined

getScheme()

Haal het schema op dat in deze URL is ingesteld.

function getScheme(): string | undefined

Retouren

string | undefined

parse(string)

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

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

Parameters

host

string | undefined

setPath(string | undefined)

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

function setPath(path: string | undefined)

Parameters

path

string | undefined

setPort(string | number | undefined)

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

function setPort(port: string | number | undefined)

Parameters

port

string | number | undefined

setQuery(string | undefined)

Stel de query in deze URL in.

function setQuery(query: string | undefined)

Parameters

query

string | undefined

setQueryParameter(string, any)

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

Parameters

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

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

Parameters

scheme

string | undefined

toString()

function toString(): string

Retouren

string