Uri class

Paket:

azure-devops-extension-api

Klasse, die einen URI darstellt und das Analysieren/Abrufen und Festlegen einzelner Teile ermöglicht

Konstruktoren

Uri(string, IUriParseOptions)

Erstellen Sie einen neuen URI.

Eigenschaften

absoluteUri	Legen Sie die absolute URI-Zeichenfolge für diesen URI fest. Ersetzt alle vorhandenen Werte.
hashString	Die Hashzeichenfolge des URI
host	Der URI-Hostname (enthält keinen Port oder Schema)
noSchemeSeparator	Wenn true, geben Sie das Trennzeichen "//" nach dem Schema nicht aus: Für Schemas wie mailto auf "true" festgelegt (z. B. mailto:foo@bar)
path	Der relative Pfad des URI
port	Die Portnummer des URI, wie in der URL angegeben. 0, wenn sie in der URL ausgelassen werden (z. B. der Standardport für das Schema).
queryParameters	Das Array von Abfrageparametern im URI
queryString	Legen Sie die Abfragezeichenfolge für diesen URI fest. Ersetzt vorhandenen Wert.
scheme	Das URI-Schema, z. B. HTTP oder HTTPS

Methoden

addQueryParam(string, null | string, boolean)	Fügt dem aktuellen URI einen Abfragezeichenfolgenparameter hinzu.
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Fügt dem aktuellen URI Abfragezeichenfolgenparameter hinzu.
getEffectivePort()	Ruft die effektive Portnummer ab, die die Standardportnummer zurückgibt, wenn sie für das angegebene Schema weggelassen wird.
getQueryParam(string)	Abrufen des Werts des Abfrageparameters mit dem angegebenen Schlüssel
removeQueryParam(string)	Entfernt einen Abfragezeichenfolgenparameter.

Details zum Konstruktor

Uri(string, IUriParseOptions)

Erstellen Sie einen neuen URI.

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

Parameter

uri

string

Optionale URI-Zeichenfolge zum Auffüllen von Werten mit

options

IUriParseOptions

Optionen zum Analysieren der URI-Zeichenfolge

Details zur Eigenschaft

absoluteUri

Legen Sie die absolute URI-Zeichenfolge für diesen URI fest. Ersetzt alle vorhandenen Werte.

absoluteUri: string

Eigenschaftswert

string

hashString

Die Hashzeichenfolge des URI

hashString: string

Eigenschaftswert

string

host

Der URI-Hostname (enthält keinen Port oder Schema)

host: string

Eigenschaftswert

string

noSchemeSeparator

Wenn true, geben Sie das Trennzeichen "//" nach dem Schema nicht aus: Für Schemas wie mailto auf "true" festgelegt (z. B. mailto:foo@bar)

noSchemeSeparator: boolean

Eigenschaftswert

boolean

path

Der relative Pfad des URI

path: string

Eigenschaftswert

string

port

Die Portnummer des URI, wie in der URL angegeben. 0, wenn sie in der URL ausgelassen werden (z. B. der Standardport für das Schema).

port: number

Eigenschaftswert

number

queryParameters

Das Array von Abfrageparametern im URI

queryParameters: IQueryParameter[]

Eigenschaftswert

IQueryParameter[]

queryString

Legen Sie die Abfragezeichenfolge für diesen URI fest. Ersetzt vorhandenen Wert.

queryString: string

Eigenschaftswert

string

scheme

Das URI-Schema, z. B. HTTP oder HTTPS

scheme: string

Eigenschaftswert

string

Details zur Methode

addQueryParam(string, null | string, boolean)

Fügt dem aktuellen URI einen Abfragezeichenfolgenparameter hinzu.

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

Parameter

name

string

Der Name des Abfrageparameters

value

null | string

Der Wert des Abfrageparameters

replaceExisting

boolean

Wenn wahr, ersetzen Sie alle vorhandenen Parameter durch denselben Namen.

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

Fügt dem aktuellen URI Abfragezeichenfolgenparameter hinzu.

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

Parameter

parameters

{[key: string]: QueryParameterValueType}

Hinzuzufügende Abfrageparameter

replaceExisting

boolean

Wenn wahr, ersetzen Sie alle vorhandenen Parameter durch denselben Namen.

keyPrefix

string

Wenn angegeben, wird ein Wert, der allen Abfrageparameterschlüsseln vorangestellt werden soll.

getEffectivePort()

Ruft die effektive Portnummer ab, die die Standardportnummer zurückgibt, wenn sie für das angegebene Schema weggelassen wird.

function getEffectivePort(): number

Gibt zurück

number

getQueryParam(string)

Abrufen des Werts des Abfrageparameters mit dem angegebenen Schlüssel

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

Parameter

name

string

Abfrageparametername

Gibt zurück

undefined | null | string

removeQueryParam(string)

Entfernt einen Abfragezeichenfolgenparameter.

function removeQueryParam(name: string)

Parameter

name

string

Der Name des Abfrageparameters