URLBuilder class

Paket:

@azure/ms-rest-js

En klass som hanterar skapande, ändring och parsning av URL:er.

Metoder

appendPath(string | undefined)	Lägg till den angivna sökvägen till den här URL:ens befintliga sökväg. Om den angivna sökvägen innehåller en fråga läggs den även till i den här URL:en.
getHost()	Hämta värden som har angetts i den här URL:en.
getPath()	Hämta sökvägen som har angetts i den här URL:en.
getPort()	Hämta porten som har angetts i den här URL:en.
getQuery()	Hämta frågan i den här URL:en.
getQueryParameterValue(string)	Hämta värdet för frågeparametern med det angivna frågeparameternamnet. Om det inte finns någon frågeparameter med det angivna namnet returneras odefinierat.
getScheme()	Hämta schemat som har angetts i den här URL:en.
parse(string)
replaceAll(string, string)	Om den angivna searchValue hittas i den här URLBuilder ersätter du den med den angivna replaceValue.
setHost(string | undefined)	Ange värden för den här URL:en. Om den angivna värden innehåller andra delar av en URL (till exempel en port, sökväg eller fråga) läggs även dessa delar till i den här URL:en.
setPath(string | undefined)	Ange sökvägen för den här URL:en. Om den angivna sökvägen innehåller en fråga läggs den även till i den här URL:en.
setPort(string | number | undefined)	Ange porten för den här URL:en. Om den angivna porten innehåller andra delar av en URL (till exempel en sökväg eller fråga) läggs även dessa delar till i den här URL:en.
setQuery(string | undefined)	Ange frågan i den här URL:en.
setQueryParameter(string, any)	Ange en frågeparameter med det angivna namnet och värdet i den här URL:ens fråga. Om det angivna frågeparametervärdet är odefinierat eller tomt tas frågeparametern bort om det fanns.
setScheme(string | undefined)	Ange schemat/protokollet för den här URL:en. Om det angivna schemat innehåller andra delar av en URL (till exempel en värd, port, sökväg eller fråga) läggs även dessa delar till i den här URL:en.
toString()

Metodinformation

appendPath(string | undefined)

Lägg till den angivna sökvägen till den här URL:ens befintliga sökväg. Om den angivna sökvägen innehåller en fråga läggs den även till i den här URL:en.

function appendPath(path: string | undefined)

Parametrar

path

string | undefined

getHost()

Hämta värden som har angetts i den här URL:en.

function getHost(): string | undefined

Returer

string | undefined

getPath()

Hämta sökvägen som har angetts i den här URL:en.

function getPath(): string | undefined

Returer

string | undefined

getPort()

Hämta porten som har angetts i den här URL:en.

function getPort(): string | undefined

Returer

string | undefined

getQuery()

Hämta frågan i den här URL:en.

function getQuery(): string | undefined

Returer

string | undefined

getQueryParameterValue(string)

Hämta värdet för frågeparametern med det angivna frågeparameternamnet. Om det inte finns någon frågeparameter med det angivna namnet returneras odefinierat.

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

Parametrar

queryParameterName

string

Returer

string | string[] | undefined

getScheme()

Hämta schemat som har angetts i den här URL:en.

function getScheme(): string | undefined

Returer

string | undefined

parse(string)

static function parse(text: string): URLBuilder

Parametrar

text

string

Returer

URLBuilder

replaceAll(string, string)

Om den angivna searchValue hittas i den här URLBuilder ersätter du den med den angivna replaceValue.

function replaceAll(searchValue: string, replaceValue: string)

Parametrar

searchValue

string

replaceValue

string

setHost(string | undefined)

Ange värden för den här URL:en. Om den angivna värden innehåller andra delar av en URL (till exempel en port, sökväg eller fråga) läggs även dessa delar till i den här URL:en.

function setHost(host: string | undefined)

Parametrar

host

string | undefined

setPath(string | undefined)

Ange sökvägen för den här URL:en. Om den angivna sökvägen innehåller en fråga läggs den även till i den här URL:en.

function setPath(path: string | undefined)

Parametrar

path

string | undefined

setPort(string | number | undefined)

Ange porten för den här URL:en. Om den angivna porten innehåller andra delar av en URL (till exempel en sökväg eller fråga) läggs även dessa delar till i den här URL:en.

function setPort(port: string | number | undefined)

Parametrar

port

string | number | undefined

setQuery(string | undefined)

Ange frågan i den här URL:en.

function setQuery(query: string | undefined)

Parametrar

query

string | undefined

setQueryParameter(string, any)

Ange en frågeparameter med det angivna namnet och värdet i den här URL:ens fråga. Om det angivna frågeparametervärdet är odefinierat eller tomt tas frågeparametern bort om det fanns.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Parametrar

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

Ange schemat/protokollet för den här URL:en. Om det angivna schemat innehåller andra delar av en URL (till exempel en värd, port, sökväg eller fråga) läggs även dessa delar till i den här URL:en.

function setScheme(scheme: string | undefined)

Parametrar

scheme

string | undefined

toString()

function toString(): string

Returer

string