Uri class

Pacote:

azure-devops-extension-api

Classe que representa um Uri e permite a análise/obtenção e a configuração de partes individuais

Construtores

Uri(string, IUriParseOptions)

Crie um novo Uri.

Propriedades

absoluteUri	Defina a cadeia de caracteres de uri absoluta para este Uri. Substitui todos os valores existentes
hashString	A cadeia de caracteres de hash do uri
host	O nome do host do URI (não inclui porta ou esquema)
noSchemeSeparator	Se for true, não emita o separador "//" após o esquema: Definido como true para esquemas como mailto (por exemplo, mailto:foo@bar)
path	O caminho relativo do uri
port	O número da porta do uri conforme fornecido na URL. 0 se deixado de fora na URL (por exemplo, a porta padrão para o esquema).
queryParameters	A matriz de parâmetros de consulta no uri
queryString	Defina a cadeia de caracteres de consulta para este Uri. Substitui o valor existente
scheme	O esquema uri, como http ou https

Métodos

addQueryParam(string, null | string, boolean)	Adiciona um parâmetro de cadeia de caracteres de consulta ao uri atual
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Adiciona parâmetros de cadeia de caracteres de consulta ao uri atual
getEffectivePort()	Obtém o número de porta efetivo, retornando o número da porta padrão se omitido para o esquema especificado.
getQueryParam(string)	Obter o valor do parâmetro de consulta com a chave fornecida
removeQueryParam(string)	Remove um parâmetro de cadeia de caracteres de consulta

Detalhes do construtor

Uri(string, IUriParseOptions)

Crie um novo Uri.

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

Parâmetros

uri

string

Cadeia de caracteres uri opcional para preencher valores com

options

IUriParseOptions

Opções para analisar a cadeia de caracteres uri

Detalhes da propriedade

absoluteUri

Defina a cadeia de caracteres de uri absoluta para este Uri. Substitui todos os valores existentes

absoluteUri: string

Valor da propriedade

string

hashString

A cadeia de caracteres de hash do uri

hashString: string

Valor da propriedade

string

host

O nome do host do URI (não inclui porta ou esquema)

host: string

Valor da propriedade

string

noSchemeSeparator

Se for true, não emita o separador "//" após o esquema: Definido como true para esquemas como mailto (por exemplo, mailto:foo@bar)

noSchemeSeparator: boolean

Valor da propriedade

boolean

path

O caminho relativo do uri

path: string

Valor da propriedade

string

port

O número da porta do uri conforme fornecido na URL. 0 se deixado de fora na URL (por exemplo, a porta padrão para o esquema).

port: number

Valor da propriedade

number

queryParameters

A matriz de parâmetros de consulta no uri

queryParameters: IQueryParameter[]

Valor da propriedade

IQueryParameter[]

queryString

Defina a cadeia de caracteres de consulta para este Uri. Substitui o valor existente

queryString: string

Valor da propriedade

string

scheme

O esquema uri, como http ou https

scheme: string

Valor da propriedade

string

Detalhes do método

addQueryParam(string, null | string, boolean)

Adiciona um parâmetro de cadeia de caracteres de consulta ao uri atual

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

Parâmetros

name

string

O nome do parâmetro De consulta

value

null | string

O valor do parâmetro De consulta

replaceExisting

boolean

Se verdadeiro, substitua todos os parâmetros existentes pelo mesmo nome

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

Adiciona parâmetros de cadeia de caracteres de consulta ao uri atual

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

Parâmetros

parameters

{[key: string]: QueryParameterValueType}

Parâmetros de consulta a serem adicionados

replaceExisting

boolean

Se verdadeiro, substitua todos os parâmetros existentes pelo mesmo nome

keyPrefix

string

Se especificado, um valor a ser anexado a todas as chaves de parâmetro de consulta

getEffectivePort()

Obtém o número de porta efetivo, retornando o número da porta padrão se omitido para o esquema especificado.

function getEffectivePort(): number

Retornos

number

getQueryParam(string)

Obter o valor do parâmetro de consulta com a chave fornecida

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

Parâmetros

name

string

Nome do parâmetro de consulta

Retornos

undefined | null | string

removeQueryParam(string)

Remove um parâmetro de cadeia de caracteres de consulta

function removeQueryParam(name: string)

Parâmetros

name

string

O nome do parâmetro De consulta