Dela via

Uri class

Paket:
azure-devops-extension-api

Klass som representerar en URI och tillåter parsning/hämtar och inställning av enskilda delar

Konstruktorer

Uri(string, IUriParseOptions)

Skapa en ny URI.

Egenskaper

absoluteUri

Ange den absoluta uri-strängen för den här URI:n. Ersätter alla befintliga värden
hashString

Hash-strängen för URI:n
host

URI-värdnamnet (inkluderar inte port eller schema)
noSchemeSeparator

Om sant genererar du inte "//"-avgränsaren efter schemat: Ställ in på true för scheman som mailto (t.ex. mailto:foo@bar)
path

URI:ns relativa sökväg
port

Portnumret för URI:n enligt url:en. 0 om det utelämnas i URL:en (t.ex. standardporten för schemat).
queryParameters

Matrisen med frågeparametrar i URI:n
queryString

Ange frågesträngen för den här URI:n. Ersätter befintligt värde
scheme

URI-schemat, till exempel http eller https

Metoder

addQueryParam(string, null | string, boolean)

Lägger till en frågesträngsparameter i den aktuella URI:n
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

Lägger till frågesträngsparametrar till den aktuella URI:n
getEffectivePort()

Hämtar det effektiva portnumret och returnerar standardportnumret om det utelämnas för det angivna schemat.
getQueryParam(string)

Hämta värdet för frågeparametern med den angivna nyckeln
removeQueryParam(string)

Tar bort en frågesträngsparameter

Konstruktorinformation

Uri(string, IUriParseOptions)

Skapa en ny URI.

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

Parametrar

uri

string

Valfri URI-sträng att fylla i värden med

options
IUriParseOptions

Alternativ för att parsa URI-strängen

Egenskapsinformation

absoluteUri

Ange den absoluta uri-strängen för den här URI:n. Ersätter alla befintliga värden

absoluteUri: string

Egenskapsvärde

string

hashString

Hash-strängen för URI:n

hashString: string

Egenskapsvärde

string

host

URI-värdnamnet (inkluderar inte port eller schema)

host: string

Egenskapsvärde

string

noSchemeSeparator

Om sant genererar du inte "//"-avgränsaren efter schemat: Ställ in på true för scheman som mailto (t.ex. mailto:foo@bar)

noSchemeSeparator: boolean

Egenskapsvärde

boolean

path

URI:ns relativa sökväg

path: string

Egenskapsvärde

string

port

Portnumret för URI:n enligt url:en. 0 om det utelämnas i URL:en (t.ex. standardporten för schemat).

port: number

Egenskapsvärde

number

queryParameters

Matrisen med frågeparametrar i URI:n

queryParameters: IQueryParameter[]

Egenskapsvärde

IQueryParameter[]

queryString

Ange frågesträngen för den här URI:n. Ersätter befintligt värde

queryString: string

Egenskapsvärde

string

scheme

URI-schemat, till exempel http eller https

scheme: string

Egenskapsvärde

string

Metodinformation

addQueryParam(string, null | string, boolean)

Lägger till en frågesträngsparameter i den aktuella URI:n

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

Parametrar

name

string

Frågeparameterns namn

value

null | string

Frågeparametervärdet

replaceExisting

boolean

Om sant ersätter du alla befintliga parametrar med samma namn

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

Lägger till frågesträngsparametrar till den aktuella URI:n

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

Parametrar

parameters

{[key: string]: QueryParameterValueType}

Frågeparametrar att lägga till

replaceExisting

boolean

Om sant ersätter du alla befintliga parametrar med samma namn

keyPrefix

string

Om det anges ett värde som ska förberedas för alla frågeparameternycklar

getEffectivePort()

Hämtar det effektiva portnumret och returnerar standardportnumret om det utelämnas för det angivna schemat.

function getEffectivePort(): number

Returer

number

getQueryParam(string)

Hämta värdet för frågeparametern med den angivna nyckeln

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

Parametrar

name

string

Frågeparameternamn

Returer

undefined | null | string

removeQueryParam(string)

Tar bort en frågesträngsparameter

function removeQueryParam(name: string)

Parametrar

name

string

Frågeparameterns namn