Uri class

Pacchetto:

azure-devops-extension-api

Classe che rappresenta un URI e consente l'analisi/recupero e l'impostazione di singole parti

Costruttori

Uri(string, IUriParseOptions)

Creare un nuovo URI.

Proprietà

absoluteUri	Impostare la stringa URI assoluta per questo Uri. Sostituisce tutti i valori esistenti
hashString	Stringa hash dell'URI
host	Nome host URI (non include porta o schema)
noSchemeSeparator	Se true, non generare il separatore "//" dopo lo schema: Impostare su true per schemi come mailto (ad esempio mailto:foo@bar)
path	Percorso relativo dell'URI
port	Numero di porta dell'URI fornito nell'URL. 0 se si esce dall'URL ,ad esempio la porta predefinita per lo schema.
queryParameters	Matrice di parametri di query nell'URI
queryString	Impostare la stringa di query per questo URI. Sostituisce il valore esistente
scheme	Schema URI, ad esempio http o https

Metodi

addQueryParam(string, null | string, boolean)	Aggiunge un parametro della stringa di query all'URI corrente
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Aggiunge i parametri della stringa di query all'URI corrente
getEffectivePort()	Ottiene il numero di porta effettivo, restituendo il numero di porta predefinito se omesso per lo schema specificato.
getQueryParam(string)	Ottenere il valore del parametro di query con la chiave specificata
removeQueryParam(string)	Rimuove un parametro della stringa di query

Dettagli costruttore

Uri(string, IUriParseOptions)

Creare un nuovo URI.

new Uri(uri?: string, options?: IUriParseOptions)

Parametri

uri

string

Stringa URI facoltativa con cui popolare i valori

options

IUriParseOptions

Opzioni per l'analisi della stringa URI

Dettagli proprietà

absoluteUri

Impostare la stringa URI assoluta per questo Uri. Sostituisce tutti i valori esistenti

absoluteUri: string

Valore della proprietà

string

hashString

Stringa hash dell'URI

hashString: string

Valore della proprietà

string

host

Nome host URI (non include porta o schema)

host: string

Valore della proprietà

string

noSchemeSeparator

Se true, non generare il separatore "//" dopo lo schema: Impostare su true per schemi come mailto (ad esempio mailto:foo@bar)

noSchemeSeparator: boolean

Valore della proprietà

boolean

path

Percorso relativo dell'URI

path: string

Valore della proprietà

string

port

Numero di porta dell'URI fornito nell'URL. 0 se si esce dall'URL ,ad esempio la porta predefinita per lo schema.

port: number

Valore della proprietà

number

queryParameters

Matrice di parametri di query nell'URI

queryParameters: IQueryParameter[]

Valore della proprietà

IQueryParameter[]

queryString

Impostare la stringa di query per questo URI. Sostituisce il valore esistente

queryString: string

Valore della proprietà

string

scheme

Schema URI, ad esempio http o https

scheme: string

Valore della proprietà

string

Dettagli metodo

addQueryParam(string, null | string, boolean)

Aggiunge un parametro della stringa di query all'URI corrente

function addQueryParam(name: string, value: null | string, replaceExisting?: boolean)

Parametri

name

string

Nome del parametro query

value

null | string

Valore del parametro Query

replaceExisting

boolean

Se true, sostituire tutti i parametri esistenti con lo stesso nome

addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

Aggiunge i parametri della stringa di query all'URI corrente

function addQueryParams(parameters: {[key: string]: QueryParameterValueType}, replaceExisting?: boolean, keyPrefix?: string)

Parametri

parameters

{[key: string]: QueryParameterValueType}

Parametri di query da aggiungere

replaceExisting

boolean

Se true, sostituire tutti i parametri esistenti con lo stesso nome

keyPrefix

string

Se specificato, un valore da anteporre a tutte le chiavi dei parametri di query

getEffectivePort()

Ottiene il numero di porta effettivo, restituendo il numero di porta predefinito se omesso per lo schema specificato.

function getEffectivePort(): number

Restituisce

number

getQueryParam(string)

Ottenere il valore del parametro di query con la chiave specificata

function getQueryParam(name: string): undefined | null | string

Parametri

name

string

Nome del parametro di query

Restituisce

undefined | null | string

removeQueryParam(string)

Rimuove un parametro della stringa di query

function removeQueryParam(name: string)

Parametri

name

string

Nome del parametro query