Partager via

Uri class

  • Référence
Paquet:
azure-devops-extension-api

Classe qui représente un URI et autorise l’analyse/obtention et le paramètre des parties individuelles

Constructeurs

Uri(string, IUriParseOptions)

Créez un URI.

Propriétés

absoluteUri

Définissez la chaîne d’URI absolue pour cet URI. Remplace toutes les valeurs existantes
hashString

Chaîne de hachage de l’URI
host

Nom d’hôte d’URI (n’inclut pas le port ou le schéma)
noSchemeSeparator

Si la valeur est true, n’émettez pas le séparateur « // » après le schéma : défini sur true pour les schémas tels que mailto (par exemple, mailto :foo@bar)
path

Chemin relatif de l’URI
port

Numéro de port de l’URI tel qu’il est fourni dans l’URL. 0 s’il est laissé dans l’URL (par exemple, le port par défaut du schéma).
queryParameters

Tableau de paramètres de requête dans l’URI
queryString

Définissez la chaîne de requête pour cet URI. Remplace la valeur existante
scheme

Schéma d’URI tel que http ou https

Méthodes

addQueryParam(string, null | string, boolean)

Ajoute un paramètre de chaîne de requête à l’URI actuel
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

Ajoute des paramètres de chaîne de requête à l’URI actuel
getEffectivePort()

Obtient le numéro de port effectif, en retournant le numéro de port par défaut s’il est omis pour le schéma donné.
getQueryParam(string)

Obtenir la valeur du paramètre de requête avec la clé donnée
removeQueryParam(string)

Supprime un paramètre de chaîne de requête

Détails du constructeur

Uri(string, IUriParseOptions)

Créez un URI.

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

Paramètres

uri

string

Chaîne d’URI facultative pour remplir des valeurs avec

options
IUriParseOptions

Options d’analyse de la chaîne d’URI

Détails de la propriété

absoluteUri

Définissez la chaîne d’URI absolue pour cet URI. Remplace toutes les valeurs existantes

absoluteUri: string

Valeur de propriété

string

hashString

Chaîne de hachage de l’URI

hashString: string

Valeur de propriété

string

host

Nom d’hôte d’URI (n’inclut pas le port ou le schéma)

host: string

Valeur de propriété

string

noSchemeSeparator

Si la valeur est true, n’émettez pas le séparateur « // » après le schéma : défini sur true pour les schémas tels que mailto (par exemple, mailto :foo@bar)

noSchemeSeparator: boolean

Valeur de propriété

boolean

path

Chemin relatif de l’URI

path: string

Valeur de propriété

string

port

Numéro de port de l’URI tel qu’il est fourni dans l’URL. 0 s’il est laissé dans l’URL (par exemple, le port par défaut du schéma).

port: number

Valeur de propriété

number

queryParameters

Tableau de paramètres de requête dans l’URI

queryParameters: IQueryParameter[]

Valeur de propriété

IQueryParameter[]

queryString

Définissez la chaîne de requête pour cet URI. Remplace la valeur existante

queryString: string

Valeur de propriété

string

scheme

Schéma d’URI tel que http ou https

scheme: string

Valeur de propriété

string

Détails de la méthode

addQueryParam(string, null | string, boolean)

Ajoute un paramètre de chaîne de requête à l’URI actuel

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

Paramètres

name

string

Nom du paramètre de requête

value

null | string

Valeur du paramètre de requête

replaceExisting

boolean

Si la valeur est true, remplacez tous les paramètres existants par le même nom

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

Ajoute des paramètres de chaîne de requête à l’URI actuel

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

Paramètres

parameters

{[key: string]: QueryParameterValueType}

Paramètres de requête à ajouter

replaceExisting

boolean

Si la valeur est true, remplacez tous les paramètres existants par le même nom

keyPrefix

string

Si elle est spécifiée, une valeur à ajouter à toutes les clés de paramètre de requête

getEffectivePort()

Obtient le numéro de port effectif, en retournant le numéro de port par défaut s’il est omis pour le schéma donné.

function getEffectivePort(): number

Retours

number

getQueryParam(string)

Obtenir la valeur du paramètre de requête avec la clé donnée

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

Paramètres

name

string

Nom du paramètre de requête

Retours

undefined | null | string

removeQueryParam(string)

Supprime un paramètre de chaîne de requête

function removeQueryParam(name: string)

Paramètres

name

string

Nom du paramètre de requête