Uri class

Balíček:

azure-devops-extension-api

Třída představující identifikátor URI a umožňuje parsování/získávání a nastavení jednotlivých částí.

Konstruktory

Uri(string, IUriParseOptions)

Vytvořte nový identifikátor URI.

Vlastnosti

absoluteUri	Nastavte absolutní řetězec identifikátoru URI pro tento identifikátor URI. Nahradí všechny existující hodnoty.
hashString	Řetězec hash identifikátoru URI
host	Název hostitele URI (nezahrnuje port ani schéma)
noSchemeSeparator	Pokud je pravda, nevysílejte za schéma oddělovač //: Nastavte na hodnotu True pro schémata, jako je mailto (např. mailto:foo@bar).
path	Relativní cesta identifikátoru URI
port	Číslo portu identifikátoru URI zadaného v adrese URL. Pokud v adrese URL vynecháte hodnotu 0 (např. výchozí port schématu).
queryParameters	Pole parametrů dotazu v identifikátoru URI
queryString	Nastavte řetězec dotazu pro tento identifikátor URI. Nahradí existující hodnotu.
scheme	Schéma identifikátoru URI, jako je http nebo https

Metody

addQueryParam(string, null | string, boolean)	Přidá do aktuálního identifikátoru URI parametr řetězce dotazu.
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Přidá parametry řetězce dotazu do aktuálního identifikátoru URI.
getEffectivePort()	Získá platné číslo portu, vrátí výchozí číslo portu, pokud není pro dané schéma vynecháno.
getQueryParam(string)	Získání hodnoty parametru dotazu s daným klíčem
removeQueryParam(string)	Odebere parametr řetězce dotazu.

Podrobnosti konstruktoru

Uri(string, IUriParseOptions)

Vytvořte nový identifikátor URI.

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

Parametry

uri

string

Volitelný řetězec identifikátoru URI pro naplnění hodnot pomocí

options

IUriParseOptions

Možnosti analýzy řetězce identifikátoru URI

Podrobnosti vlastnosti

absoluteUri

Nastavte absolutní řetězec identifikátoru URI pro tento identifikátor URI. Nahradí všechny existující hodnoty.

absoluteUri: string

Hodnota vlastnosti

string

hashString

Řetězec hash identifikátoru URI

hashString: string

Hodnota vlastnosti

string

host

Název hostitele URI (nezahrnuje port ani schéma)

host: string

Hodnota vlastnosti

string

noSchemeSeparator

Pokud je pravda, nevysílejte za schéma oddělovač //: Nastavte na hodnotu True pro schémata, jako je mailto (např. mailto:foo@bar).

noSchemeSeparator: boolean

Hodnota vlastnosti

boolean

path

Relativní cesta identifikátoru URI

path: string

Hodnota vlastnosti

string

port

Číslo portu identifikátoru URI zadaného v adrese URL. Pokud v adrese URL vynecháte hodnotu 0 (např. výchozí port schématu).

port: number

Hodnota vlastnosti

number

queryParameters

Pole parametrů dotazu v identifikátoru URI

queryParameters: IQueryParameter[]

Hodnota vlastnosti

IQueryParameter[]

queryString

Nastavte řetězec dotazu pro tento identifikátor URI. Nahradí existující hodnotu.

queryString: string

Hodnota vlastnosti

string

scheme

Schéma identifikátoru URI, jako je http nebo https

scheme: string

Hodnota vlastnosti

string

Podrobnosti metody

addQueryParam(string, null | string, boolean)

Přidá do aktuálního identifikátoru URI parametr řetězce dotazu.

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

Parametry

name

string

Název parametru dotazu

value

null | string

Hodnota parametru dotazu

replaceExisting

boolean

Pokud je hodnota true, nahraďte všechny existující parametry stejným názvem.

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

Přidá parametry řetězce dotazu do aktuálního identifikátoru URI.

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

Parametry

parameters

{[key: string]: QueryParameterValueType}

Parametry dotazu pro přidání

replaceExisting

boolean

Pokud je hodnota true, nahraďte všechny existující parametry stejným názvem.

keyPrefix

string

Pokud je zadáno, hodnota, která se má předem připojit ke všem klíčům parametrů dotazu

getEffectivePort()

Získá platné číslo portu, vrátí výchozí číslo portu, pokud není pro dané schéma vynecháno.

function getEffectivePort(): number

Návraty

number

getQueryParam(string)

Získání hodnoty parametru dotazu s daným klíčem

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

Parametry

name

string

Název parametru dotazu

Návraty

undefined | null | string

removeQueryParam(string)

Odebere parametr řetězce dotazu.

function removeQueryParam(name: string)

Parametry

name

string

Název parametru dotazu