Compartir a través de

Uri class

  • Referencia
Paquete:
azure-devops-extension-api

Clase que representa un URI y permite analizar o obtener y establecer elementos individuales

Constructores

Uri(string, IUriParseOptions)

Cree un nuevo URI.

Propiedades

absoluteUri

Establezca la cadena de URI absoluta para este URI. Reemplaza todos los valores existentes.
hashString

Cadena hash del URI
host

El nombre de host del URI (no incluye el puerto ni el esquema)
noSchemeSeparator

Si es true, no emita el separador "//" después del esquema: se establece en true para esquemas como mailto (por ejemplo, mailto:foo@bar)
path

Ruta de acceso relativa del URI
port

Número de puerto del URI proporcionado en la dirección URL. 0 si se deja fuera en la dirección URL (por ejemplo, el puerto predeterminado para el esquema).
queryParameters

Matriz de parámetros de consulta en el URI
queryString

Establezca la cadena de consulta para este URI. Reemplaza el valor existente.
scheme

Esquema de uri como http o https

Métodos

addQueryParam(string, null | string, boolean)

Agrega un parámetro de cadena de consulta al URI actual
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

Agrega parámetros de cadena de consulta al URI actual
getEffectivePort()

Obtiene el número de puerto efectivo y devuelve el número de puerto predeterminado si se omite para el esquema especificado.
getQueryParam(string)

Obtención del valor del parámetro de consulta con la clave especificada
removeQueryParam(string)

Quita un parámetro de cadena de consulta.

Detalles del constructor

Uri(string, IUriParseOptions)

Cree un nuevo URI.

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

Parámetros

uri

string

Cadena de URI opcional para rellenar los valores con

options
IUriParseOptions

Opciones para analizar la cadena de URI

Detalles de las propiedades

absoluteUri

Establezca la cadena de URI absoluta para este URI. Reemplaza todos los valores existentes.

absoluteUri: string

Valor de propiedad

string

hashString

Cadena hash del URI

hashString: string

Valor de propiedad

string

host

El nombre de host del URI (no incluye el puerto ni el esquema)

host: string

Valor de propiedad

string

noSchemeSeparator

Si es true, no emita el separador "//" después del esquema: se establece en true para esquemas como mailto (por ejemplo, mailto:foo@bar)

noSchemeSeparator: boolean

Valor de propiedad

boolean

path

Ruta de acceso relativa del URI

path: string

Valor de propiedad

string

port

Número de puerto del URI proporcionado en la dirección URL. 0 si se deja fuera en la dirección URL (por ejemplo, el puerto predeterminado para el esquema).

port: number

Valor de propiedad

number

queryParameters

Matriz de parámetros de consulta en el URI

queryParameters: IQueryParameter[]

Valor de propiedad

IQueryParameter[]

queryString

Establezca la cadena de consulta para este URI. Reemplaza el valor existente.

queryString: string

Valor de propiedad

string

scheme

Esquema de uri como http o https

scheme: string

Valor de propiedad

string

Detalles del método

addQueryParam(string, null | string, boolean)

Agrega un parámetro de cadena de consulta al URI actual

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

Parámetros

name

string

Nombre del parámetro Query

value

null | string

Valor del parámetro Query

replaceExisting

boolean

Si es true, reemplace todos los parámetros existentes por el mismo nombre.

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

Agrega parámetros de cadena de consulta al URI actual

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

Parámetros

parameters

{[key: string]: QueryParameterValueType}

Parámetros de consulta que se van a agregar

replaceExisting

boolean

Si es true, reemplace todos los parámetros existentes por el mismo nombre.

keyPrefix

string

Si se especifica, un valor que se va a anteponer a todas las claves de parámetro de consulta

getEffectivePort()

Obtiene el número de puerto efectivo y devuelve el número de puerto predeterminado si se omite para el esquema especificado.

function getEffectivePort(): number

Devoluciones

number

getQueryParam(string)

Obtención del valor del parámetro de consulta con la clave especificada

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

Parámetros

name

string

Nombre del parámetro de consulta

Devoluciones

undefined | null | string

removeQueryParam(string)

Quita un parámetro de cadena de consulta.

function removeQueryParam(name: string)

Parámetros

name

string

Nombre del parámetro Query