Uri class

Pakiet:

azure-devops-extension-api

Klasa reprezentująca identyfikator URI i zezwala na analizowanie/pobieranie i ustawianie poszczególnych części

Konstruktory

Uri(string, IUriParseOptions)

Utwórz nowy identyfikator URI.

Właściwości

absoluteUri	Ustaw bezwzględny ciąg identyfikatora URI dla tego identyfikatora URI. Zamienia wszystkie istniejące wartości
hashString	Ciąg skrótu identyfikatora URI
host	Nazwa hosta identyfikatora URI (nie zawiera portu ani schematu)
noSchemeSeparator	Jeśli wartość true, nie emituj separatora "//" po schemacie: ustaw wartość true dla schematów, takich jak mailto (np. mailto:foo@bar)
path	Ścieżka względna identyfikatora URI
port	Numer portu identyfikatora URI podany w adresie URL. 0, jeśli pominięto w adresie URL (np. domyślny port schematu).
queryParameters	Tablica parametrów zapytania w identyfikatorze URI
queryString	Ustaw ciąg zapytania dla tego identyfikatora URI. Zamienia istniejącą wartość
scheme	Schemat identyfikatora URI, taki jak http lub https

Metody

addQueryParam(string, null | string, boolean)	Dodaje parametr ciągu zapytania do bieżącego identyfikatora URI
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Dodaje parametry ciągu zapytania do bieżącego identyfikatora URI
getEffectivePort()	Pobiera skuteczny numer portu, zwracając domyślny numer portu, jeśli pominięto dla danego schematu.
getQueryParam(string)	Pobieranie wartości parametru zapytania przy użyciu danego klucza
removeQueryParam(string)	Usuwa parametr ciągu zapytania

Szczegóły konstruktora

Uri(string, IUriParseOptions)

Utwórz nowy identyfikator URI.

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

Parametry

uri

string

Opcjonalny ciąg identyfikatora URI do wypełniania wartości za pomocą polecenia

options

IUriParseOptions

Opcje analizowania ciągu identyfikatora URI

Szczegóły właściwości

absoluteUri

Ustaw bezwzględny ciąg identyfikatora URI dla tego identyfikatora URI. Zamienia wszystkie istniejące wartości

absoluteUri: string

Wartość właściwości

string

hashString

Ciąg skrótu identyfikatora URI

hashString: string

Wartość właściwości

string

host

Nazwa hosta identyfikatora URI (nie zawiera portu ani schematu)

host: string

Wartość właściwości

string

noSchemeSeparator

Jeśli wartość true, nie emituj separatora "//" po schemacie: ustaw wartość true dla schematów, takich jak mailto (np. mailto:foo@bar)

noSchemeSeparator: boolean

Wartość właściwości

boolean

path

Ścieżka względna identyfikatora URI

path: string

Wartość właściwości

string

port

Numer portu identyfikatora URI podany w adresie URL. 0, jeśli pominięto w adresie URL (np. domyślny port schematu).

port: number

Wartość właściwości

number

queryParameters

Tablica parametrów zapytania w identyfikatorze URI

queryParameters: IQueryParameter[]

Wartość właściwości

IQueryParameter[]

queryString

Ustaw ciąg zapytania dla tego identyfikatora URI. Zamienia istniejącą wartość

queryString: string

Wartość właściwości

string

scheme

Schemat identyfikatora URI, taki jak http lub https

scheme: string

Wartość właściwości

string

Szczegóły metody

addQueryParam(string, null | string, boolean)

Dodaje parametr ciągu zapytania do bieżącego identyfikatora URI

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

Parametry

name

string

Nazwa parametru zapytania

value

null | string

Wartość parametru zapytania

replaceExisting

boolean

Jeśli wartość true, zastąp wszystkie istniejące parametry tą samą nazwą

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

Dodaje parametry ciągu zapytania do bieżącego identyfikatora URI

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

Parametry

parameters

{[key: string]: QueryParameterValueType}

Parametry zapytania do dodania

replaceExisting

boolean

Jeśli wartość true, zastąp wszystkie istniejące parametry tą samą nazwą

keyPrefix

string

W przypadku określenia wartości, która ma być poprzedzana wszystkimi kluczami parametrów zapytania

getEffectivePort()

Pobiera skuteczny numer portu, zwracając domyślny numer portu, jeśli pominięto dla danego schematu.

function getEffectivePort(): number

Zwraca

number

getQueryParam(string)

Pobieranie wartości parametru zapytania przy użyciu danego klucza

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

Parametry

name

string

Nazwa parametru zapytania

Zwraca

undefined | null | string

removeQueryParam(string)

Usuwa parametr ciągu zapytania

function removeQueryParam(name: string)

Parametry

name

string

Nazwa parametru zapytania