Uri class

Пакет:

azure-devops-extension-api

Класс, представляющий универсальный код ресурса (URI) и позволяющий анализировать и получать и задавать отдельные части.

Конструкторы

Uri(string, IUriParseOptions)

Создайте новый универсальный код ресурса (URI).

Свойства

absoluteUri	Задайте абсолютную строку URI для этого URI. Заменяет все существующие значения
hashString	Хэш-строка URI
host	Имя узла URI (не включает порт или схему)
noSchemeSeparator	Если значение true, не следует выдавать разделитель "//" после схемы: задайте значение true для таких схем, как mailto (например, mailto:foo@bar)
path	Относительный путь URI
port	Номер порта URI, указанный в URL-адресе. Значение 0, если в URL-адресе (например, порт по умолчанию для схемы).
queryParameters	Массив параметров запроса в URI
queryString	Задайте строку запроса для этого URI. Заменяет существующее значение
scheme	Схема URI, например http или https

Методы

addQueryParam(string, null | string, boolean)	Добавляет параметр строки запроса в текущий универсальный код ресурса (URI)
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Добавляет параметры строки запроса в текущий универсальный код ресурса (URI)
getEffectivePort()	Возвращает действующий номер порта, возвращая номер порта по умолчанию, если опущен для данной схемы.
getQueryParam(string)	Получение значения параметра запроса с заданным ключом
removeQueryParam(string)	Удаляет параметр строки запроса

Сведения о конструкторе

Uri(string, IUriParseOptions)

Создайте новый универсальный код ресурса (URI).

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

Параметры

uri

string

Необязательная строка URI для заполнения значений

options

IUriParseOptions

Параметры синтаксического анализа строки URI

Сведения о свойстве

absoluteUri

Задайте абсолютную строку URI для этого URI. Заменяет все существующие значения

absoluteUri: string

Значение свойства

string

hashString

Хэш-строка URI

hashString: string

Значение свойства

string

host

Имя узла URI (не включает порт или схему)

host: string

Значение свойства

string

noSchemeSeparator

Если значение true, не следует выдавать разделитель "//" после схемы: задайте значение true для таких схем, как mailto (например, mailto:foo@bar)

noSchemeSeparator: boolean

Значение свойства

boolean

path

Относительный путь URI

path: string

Значение свойства

string

port

Номер порта URI, указанный в URL-адресе. Значение 0, если в URL-адресе (например, порт по умолчанию для схемы).

port: number

Значение свойства

number

queryParameters

Массив параметров запроса в URI

queryParameters: IQueryParameter[]

Значение свойства

IQueryParameter[]

queryString

Задайте строку запроса для этого URI. Заменяет существующее значение

queryString: string

Значение свойства

string

scheme

Схема URI, например http или https

scheme: string

Значение свойства

string

Сведения о методе

addQueryParam(string, null | string, boolean)

Добавляет параметр строки запроса в текущий универсальный код ресурса (URI)

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

Параметры

name

string

Имя параметра запроса

value

null | string

Значение параметра запроса

replaceExisting

boolean

Если значение true, замените все существующие параметры одинаковым именем.

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

Добавляет параметры строки запроса в текущий универсальный код ресурса (URI)

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

Параметры

parameters

{[key: string]: QueryParameterValueType}

Параметры запроса для добавления

replaceExisting

boolean

Если значение true, замените все существующие параметры одинаковым именем.

keyPrefix

string

Если задано, значение для подготовки ко всем ключам параметров запроса

getEffectivePort()

Возвращает действующий номер порта, возвращая номер порта по умолчанию, если опущен для данной схемы.

function getEffectivePort(): number

Возвращаемое значение

number

getQueryParam(string)

Получение значения параметра запроса с заданным ключом

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

Параметры

name

string

Имя параметра запроса

Возвращаемое значение

undefined | null | string

removeQueryParam(string)

Удаляет параметр строки запроса

function removeQueryParam(name: string)

Параметры

name

string

Имя параметра запроса