URLBuilder class

Pacchetto:

@azure/ms-rest-js

Classe che gestisce la creazione, la modifica e l'analisi degli URL.

Metodi

appendPath(undefined | string)	Aggiungere il percorso specificato al percorso esistente dell'URL. Se il percorso specificato contiene una query, verrà aggiunto anche a questo URL.
getHost()	Ottenere l'host impostato in questo URL.
getPath()	Ottenere il percorso impostato in questo URL.
getPort()	Ottenere la porta impostata in questo URL.
getQuery()	Ottenere la query in questo URL.
getQueryParameterValue(string)	Ottenere il valore del parametro di query con il nome del parametro di query specificato. Se non esiste alcun parametro di query con il nome specificato, verrà restituito undefined.
getScheme()	Ottenere lo schema impostato in questo URL.
parse(string)
replaceAll(string, string)	Se il valore searchValue specificato viene trovato in questo URLBuilder, sostituirlo con il valore replaceValue specificato.
setHost(undefined | string)	Impostare l'host per questo URL. Se l'host fornito contiene altre parti di un URL , ad esempio una porta, un percorso o una query, tali parti verranno aggiunte anche a questo URL.
setPath(undefined | string)	Impostare il percorso per questo URL. Se il percorso specificato contiene una query, verrà aggiunto anche a questo URL.
setPort(undefined | string | number)	Impostare la porta per questo URL. Se la porta specificata contiene altre parti di un URL ,ad esempio un percorso o una query, tali parti verranno aggiunte anche a questo URL.
setQuery(undefined | string)	Impostare la query in questo URL.
setQueryParameter(string, any)	Impostare un parametro di query con il nome e il valore specificati nella query di questo URL. Se il valore del parametro di query specificato non è definito o vuoto, il parametro di query verrà rimosso se presente.
setScheme(undefined | string)	Impostare lo schema/protocollo per questo URL. Se lo schema fornito contiene altre parti di un URL ,ad esempio un host, una porta, un percorso o una query, tali parti verranno aggiunte anche a questo URL.
toString()

Dettagli metodo

appendPath(undefined | string)

Aggiungere il percorso specificato al percorso esistente dell'URL. Se il percorso specificato contiene una query, verrà aggiunto anche a questo URL.

function appendPath(path: undefined | string)

Parametri

path

undefined | string

getHost()

Ottenere l'host impostato in questo URL.

function getHost(): undefined | string

Restituisce

undefined | string

getPath()

Ottenere il percorso impostato in questo URL.

function getPath(): undefined | string

Restituisce

undefined | string

getPort()

Ottenere la porta impostata in questo URL.

function getPort(): undefined | string

Restituisce

undefined | string

getQuery()

Ottenere la query in questo URL.

function getQuery(): undefined | string

Restituisce

undefined | string

getQueryParameterValue(string)

Ottenere il valore del parametro di query con il nome del parametro di query specificato. Se non esiste alcun parametro di query con il nome specificato, verrà restituito undefined.

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

Parametri

queryParameterName

string

Restituisce

undefined | string | string[]

getScheme()

Ottenere lo schema impostato in questo URL.

function getScheme(): undefined | string

Restituisce

undefined | string

parse(string)

static function parse(text: string): URLBuilder

Parametri

text

string

Restituisce

URLBuilder

replaceAll(string, string)

Se il valore searchValue specificato viene trovato in questo URLBuilder, sostituirlo con il valore replaceValue specificato.

function replaceAll(searchValue: string, replaceValue: string)

Parametri

searchValue

string

replaceValue

string

setHost(undefined | string)

Impostare l'host per questo URL. Se l'host fornito contiene altre parti di un URL , ad esempio una porta, un percorso o una query, tali parti verranno aggiunte anche a questo URL.

function setHost(host: undefined | string)

Parametri

host

undefined | string

setPath(undefined | string)

Impostare il percorso per questo URL. Se il percorso specificato contiene una query, verrà aggiunto anche a questo URL.

function setPath(path: undefined | string)

Parametri

path

undefined | string

setPort(undefined | string | number)

Impostare la porta per questo URL. Se la porta specificata contiene altre parti di un URL ,ad esempio un percorso o una query, tali parti verranno aggiunte anche a questo URL.

function setPort(port: undefined | string | number)

Parametri

port

undefined | string | number

setQuery(undefined | string)

Impostare la query in questo URL.

function setQuery(query: undefined | string)

Parametri

query

undefined | string

setQueryParameter(string, any)

Impostare un parametro di query con il nome e il valore specificati nella query di questo URL. Se il valore del parametro di query specificato non è definito o vuoto, il parametro di query verrà rimosso se presente.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Parametri

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

Impostare lo schema/protocollo per questo URL. Se lo schema fornito contiene altre parti di un URL ,ad esempio un host, una porta, un percorso o una query, tali parti verranno aggiunte anche a questo URL.

function setScheme(scheme: undefined | string)

Parametri

scheme

undefined | string

toString()

function toString(): string

Restituisce

string