通过

Uri class

  • 参考
包:
azure-devops-extension-api

表示 URI 并允许分析/获取和设置各个部件的类

构造函数

Uri(string, IUriParseOptions)

创建新的 URI。

属性

absoluteUri

为此 URI 设置绝对 URI 字符串。 替换所有现有值
hashString

URI 的哈希字符串
host

URI 主机名（不包括端口或方案）
noSchemeSeparator

如果为 true，请不要在方案后发出“//”分隔符：对于 mailto（例如 mailto：foo@bar）等方案设置为 true
path

URI 的相对路径
port

URL 中提供的 URI 的端口号。 如果 URL 中被排除（例如方案的默认端口），则为 0。
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，请不要在方案后发出“//”分隔符：对于 mailto（例如 mailto：foo@bar）等方案设置为 true

noSchemeSeparator: boolean

属性值

boolean

path

URI 的相对路径

path: string

属性值

string

port

URL 中提供的 URI 的端口号。 如果 URL 中被排除（例如方案的默认端口），则为 0。

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

查询参数名称