PagedList interface

包:

azure-devops-extension-api

包含查询中单个结果页的列表。

扩展

Array<T>

属性

continuationToken

可以传递给返回此 PagedList 的同一终结点的字符串，以便检索下一页的结果。

继承属性

length

获取或设置数组的长度。 这是高于数组中最高索引的数字。

继承的方法

at(number)	获取整数值并返回该索引处的项，从而允许正整数和负整数。 负整数从数组中的最后一项计数回退。
concat((T | ConcatArray<T>)[])	合并两个或多个数组。 此方法返回一个新数组，而不修改任何现有数组。
concat(ConcatArray<T>[])	合并两个或多个数组。 此方法返回一个新数组，而不修改任何现有数组。
copyWithin(number, number, number)	在从位置目标开始到同一数组的开始和结尾复制数组部分后返回此对象
entries()	返回数组中每个条目的键值对的迭代值对
every((value: T, index: number, array: T[]) => unknown, any)	确定数组的所有成员是否满足指定的测试。
every<S>((value: T, index: number, array: T[]) => value, any)	确定数组的所有成员是否满足指定的测试。
fill(T, number, number)	将所有数组元素从 start 更改为 end 索引更改为静态 value 并返回修改后的数组
filter((value: T, index: number, array: T[]) => unknown, any)	返回满足回调函数中指定的条件的数组的元素。
filter<S>((value: T, index: number, array: T[]) => value, any)	返回满足回调函数中指定的条件的数组的元素。
find((value: T, index: number, obj: T[]) => unknown, any)
find<S>((this: void, value: T, index: number, obj: T[]) => value, any)	返回数组中谓词为 true 且未定义的第一个元素的值。
findIndex((value: T, index: number, obj: T[]) => unknown, any)	返回数组中谓词为 true 的第一个元素的索引，否则 -1。
flat<A, D>(A, D)	返回一个新数组，其中所有子数组元素以递归方式连接到指定深度。
flatMap<U, This>((this: This, value: T, index: number, array: T[]) => U | (readonly U[]), This)	对数组的每个元素调用定义的回调函数。 然后，将结果平展到新的数组中。 这与地图后跟深度为 1 的平面图相同。
forEach((value: T, index: number, array: T[]) => void, any)	对数组中的每个元素执行指定的操作。
includes(T, number)	确定数组是否包含特定元素，并根据需要返回 true 还是 false。
indexOf(T, number)	返回数组中值的第一个匹配项的索引，或返回 -1（如果不存在）。
join(string)	将数组的所有元素添加到由指定的分隔符字符串分隔的字符串中。
keys()	返回数组中的键可迭代
lastIndexOf(T, number)	返回数组中指定值的最后一个匹配项的索引;如果不存在，则返回 -1 索引。
map<U>((value: T, index: number, array: T[]) => U, any)	对数组的每个元素调用定义的回调函数，并返回一个包含结果的数组。
pop()	从数组中删除最后一个元素并返回它。 如果数组为空，则返回未定义且数组未修改。
push(T[])	将新元素追加到数组的末尾，并返回数组的新长度。
reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)	为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。
reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)
reduce<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)	为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。
reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)	按降序调用数组中所有元素的指定回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。
reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)
reduceRight<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)	按降序调用数组中所有元素的指定回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。
reverse()	反转数组中的元素。 此方法将改变数组并返回对同一数组的引用。
shift()	从数组中删除第一个元素并返回它。 如果数组为空，则返回未定义且数组未修改。
slice(number, number)	返回数组的节的副本。 对于开始和结束，可以使用负索引来指示数组末尾的偏移量。 例如，-2 引用数组的第二个到最后一个元素。
some((value: T, index: number, array: T[]) => unknown, any)	确定指定的回调函数是否为数组的任何元素返回 true。
sort((a: T, b: T) => number)	就地对数组进行排序。 此方法将改变数组并返回对同一数组的引用。
splice(number, number)	从数组中删除元素，并在必要时在其位置插入新元素，并返回已删除的元素。
splice(number, number, T[])	从数组中删除元素，并在必要时在其位置插入新元素，并返回已删除的元素。
toLocaleString()	返回数组的字符串表示形式。 元素使用其 toLocaleString 方法转换为字符串。
toString()	返回数组的字符串表示形式。
unshift(T[])	在数组的开头插入新元素，并返回数组的新长度。
values()	返回数组中值的可迭代值
[iterator]()	迭 代
[unscopables]()	返回一个对象，其属性在“with”语句中使用时将缺少值“true”。

属性详细信息

continuationToken

可以传递给返回此 PagedList 的同一终结点的字符串，以便检索下一页的结果。

continuationToken: null | string

属性值

null | string

继承属性详细信息

length

获取或设置数组的长度。 这是高于数组中最高索引的数字。

length: number

属性值

number

继承自 Array.length

继承的方法详细信息

at(number)

获取整数值并返回该索引处的项，从而允许正整数和负整数。 负整数从数组中的最后一项计数回退。

function at(index: number): undefined | T

参数

index

number

返回

undefined | T

继承自 Array.at 的

concat((T | ConcatArray<T>)[])

合并两个或多个数组。 此方法返回一个新数组，而不修改任何现有数组。

function concat(items: (T | ConcatArray<T>)[]): T[]

参数

items

(T | ConcatArray<T>)[]

要添加到数组末尾的其他数组和/或项。

返回

T[]

继承自 Array.concat 的

concat(ConcatArray<T>[])

合并两个或多个数组。 此方法返回一个新数组，而不修改任何现有数组。

function concat(items: ConcatArray<T>[]): T[]

参数

items

ConcatArray<T>[]

要添加到数组末尾的其他数组和/或项。

返回

T[]

继承自 Array.concat 的

copyWithin(number, number, number)

在从位置目标开始到同一数组的开始和结尾复制数组部分后返回此对象

function copyWithin(target: number, start: number, end?: number): PagedList<T>

参数

target

number

如果目标为负数，则将其视为长度+目标，其中长度是数组的长度。

start

number

如果 start 为负数，则被视为 length+start。 如果结束为负数，则被视为长度+结束。

end

number

如果未指定，此对象的长度将用作其默认值。

返回

PagedList<T>

继承自 Array.copyWithin

entries()

返回数组中每个条目的键值对的迭代值对

function entries(): IterableIterator<[number, T]>

返回

IterableIterator<[number, T]>

继承自 Array.entries

every((value: T, index: number, array: T[]) => unknown, any)

确定数组的所有成员是否满足指定的测试。

function every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean

参数

predicate

(value: T, index: number, array: T[]) => unknown

最多接受三个参数的函数。 每个方法都会调用数组中每个元素的谓词函数，直到谓词返回一个值，该值可强制布尔值 false，或直到数组的末尾。

thisArg

any

此关键字可以在谓词函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

boolean

继承自 Array.every

every<S>((value: T, index: number, array: T[]) => value, any)

确定数组的所有成员是否满足指定的测试。

function every<S>(predicate: (value: T, index: number, array: T[]) => value, thisArg?: any): this

参数

predicate

(value: T, index: number, array: T[]) => value

最多接受三个参数的函数。 每个方法都会调用数组中每个元素的谓词函数，直到谓词返回一个值，该值可强制布尔值 false，或直到数组的末尾。

thisArg

any

此关键字可以在谓词函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

this

继承自 Array.every

fill(T, number, number)

将所有数组元素从 start 更改为 end 索引更改为静态 value 并返回修改后的数组

function fill(value: T, start?: number, end?: number): PagedList<T>

参数

value

T

要用 填充数组部分的值

start

number

要开始填充数组的索引。 如果 start 为负数，则被视为 length+start，其中长度是数组的长度。

end

number

要停止填充数组的索引。 如果结束为负数，则被视为长度+结束。

返回

PagedList<T>

继承自 Array.fill

filter((value: T, index: number, array: T[]) => unknown, any)

返回满足回调函数中指定的条件的数组的元素。

function filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[]

参数

predicate

(value: T, index: number, array: T[]) => unknown

最多接受三个参数的函数。 筛选器方法为数组中的每个元素调用谓词函数一次。

thisArg

any

此关键字可以在谓词函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

T[]

继承自 Array.filter

filter<S>((value: T, index: number, array: T[]) => value, any)

返回满足回调函数中指定的条件的数组的元素。

function filter<S>(predicate: (value: T, index: number, array: T[]) => value, thisArg?: any): S[]

参数

predicate

(value: T, index: number, array: T[]) => value

最多接受三个参数的函数。 筛选器方法为数组中的每个元素调用谓词函数一次。

thisArg

any

此关键字可以在谓词函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

S[]

继承自 Array.filter

find((value: T, index: number, obj: T[]) => unknown, any)

function find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): undefined | T

参数

predicate

(value: T, index: number, obj: T[]) => unknown

thisArg

any

返回

undefined | T

继承自 Array.find

find<S>((this: void, value: T, index: number, obj: T[]) => value, any)

返回数组中谓词为 true 且未定义的第一个元素的值。

function find<S>(predicate: (this: void, value: T, index: number, obj: T[]) => value, thisArg?: any): undefined | S

参数

predicate

(this: void, value: T, index: number, obj: T[]) => value

查找数组的每个元素的调用谓词一次（升序），直到找到谓词返回 true 的元素。 如果找到此类元素，则查找将立即返回该元素值。 否则，查找将返回未定义。

thisArg

any

如果提供，它将用作每个谓词调用的此值。 如果未提供，则改用未定义。

返回

undefined | S

继承自 Array.find

findIndex((value: T, index: number, obj: T[]) => unknown, any)

返回数组中谓词为 true 的第一个元素的索引，否则 -1。

function findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number

参数

predicate

(value: T, index: number, obj: T[]) => unknown

查找数组的每个元素的调用谓词一次（升序），直到找到谓词返回 true 的元素。 如果找到此类元素，findIndex 将立即返回该元素索引。 否则，findIndex 返回 -1。

thisArg

any

如果提供，它将用作每个谓词调用的此值。 如果未提供，则改用未定义。

返回

number

继承自 Array.findIndex

flat<A, D>(A, D)

返回一个新数组，其中所有子数组元素以递归方式连接到指定深度。

function flat<A, D>(this: A, depth?: D): FlatArray<A, D>[]

参数

this

A

depth

D

最大递归深度

返回

FlatArray<A, D>[]

继承自 Array.flat

flatMap<U, This>((this: This, value: T, index: number, array: T[]) => U | (readonly U[]), This)

对数组的每个元素调用定义的回调函数。 然后，将结果平展到新的数组中。 这与地图后跟深度为 1 的平面图相同。

function flatMap<U, This>(callback: (this: This, value: T, index: number, array: T[]) => U | (readonly U[]), thisArg?: This): U[]

参数

callback

(this: This, value: T, index: number, array: T[]) => U | (readonly U[])

最多接受三个参数的函数。 flatMap 方法为数组中的每个元素调用回调函数一次。

thisArg

This

此关键字可以在回调函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

U[]

继承自 Array.flatMap 的

forEach((value: T, index: number, array: T[]) => void, any)

对数组中的每个元素执行指定的操作。

function forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any)

参数

callbackfn

(value: T, index: number, array: T[]) => void

最多接受三个参数的函数。 forEach 为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

继承自 Array.forEach

includes(T, number)

确定数组是否包含特定元素，并根据需要返回 true 还是 false。

function includes(searchElement: T, fromIndex?: number): boolean

参数

searchElement

T

要搜索的元素。

fromIndex

number

此数组中开始搜索 searchElement 的位置。

返回

boolean

继承自 Array.includes

indexOf(T, number)

返回数组中值的第一个匹配项的索引，或返回 -1（如果不存在）。

function indexOf(searchElement: T, fromIndex?: number): number

参数

searchElement

T

要在数组中查找的值。

fromIndex

number

开始搜索的数组索引。 如果省略 fromIndex，则搜索从索引 0 开始。

返回

number

继承自 Array.indexOf

join(string)

将数组的所有元素添加到由指定的分隔符字符串分隔的字符串中。

function join(separator?: string): string

参数

separator

string

一个字符串，用于将数组的一个元素与生成的字符串中的下一个元素分开。 如果省略，则用逗号分隔数组元素。

返回

string

继承自 Array.join

keys()

返回数组中的键可迭代

function keys(): IterableIterator<number>

返回

IterableIterator<number>

继承自 Array.keys

lastIndexOf(T, number)

返回数组中指定值的最后一个匹配项的索引;如果不存在，则返回 -1 索引。

function lastIndexOf(searchElement: T, fromIndex?: number): number

参数

searchElement

T

要在数组中查找的值。

fromIndex

number

开始向后搜索的数组索引。 如果省略 fromIndex，则搜索从数组中的最后一个索引开始。

返回

number

继承自 Array.lastIndexOf

map<U>((value: T, index: number, array: T[]) => U, any)

对数组的每个元素调用定义的回调函数，并返回一个包含结果的数组。

function map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[]

参数

callbackfn

(value: T, index: number, array: T[]) => U

最多接受三个参数的函数。 map 方法为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

U[]

继承自 Array.map

pop()

从数组中删除最后一个元素并返回它。 如果数组为空，则返回未定义且数组未修改。

function pop(): undefined | T

返回

undefined | T

继承自 Array.pop

push(T[])

将新元素追加到数组的末尾，并返回数组的新长度。

function push(items: T[]): number

参数

items

T[]

要添加到数组的新元素。

返回

number

继承自 Array.push

reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)

为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。

function reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T

参数

callbackfn

(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

最多接受四个参数的函数。 reduce 方法每次调用数组中每个元素的 callbackfn 函数。

返回

T

继承自 Array.reduce

reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)

function reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T

参数

callbackfn

(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

initialValue

T

返回

T

继承自 Array.reduce

reduce<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)

为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。

function reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U

参数

callbackfn

(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U

最多接受四个参数的函数。 reduce 方法每次调用数组中每个元素的 callbackfn 函数。

initialValue

U

如果指定 initialValue，则将其用作启动累积的初始值。 对 callbackfn 函数的第一次调用将此值作为参数而不是数组值提供。

返回

U

继承自 Array.reduce

reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)

按降序调用数组中所有元素的指定回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。

function reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T

参数

callbackfn

(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

最多接受四个参数的函数。 reduceRight 方法为数组中的每个元素调用回调fn 函数一次。

返回

T

继承自 Array.reduceRight

reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)

function reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T

参数

callbackfn

(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

initialValue

T

返回

T

继承自 Array.reduceRight

reduceRight<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)

按降序调用数组中所有元素的指定回调函数。 回调函数的返回值是累积的结果，并在下一次调用回调函数时作为参数提供。

function reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U

参数

callbackfn

(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U

最多接受四个参数的函数。 reduceRight 方法为数组中的每个元素调用回调fn 函数一次。

initialValue

U

如果指定 initialValue，则将其用作启动累积的初始值。 对 callbackfn 函数的第一次调用将此值作为参数而不是数组值提供。

返回

U

继承自 Array.reduceRight

reverse()

反转数组中的元素。 此方法将改变数组并返回对同一数组的引用。

function reverse(): T[]

返回

T[]

继承自 Array.reverse

shift()

从数组中删除第一个元素并返回它。 如果数组为空，则返回未定义且数组未修改。

function shift(): undefined | T

返回

undefined | T

继承自 Array.shift

slice(number, number)

返回数组的节的副本。 对于开始和结束，可以使用负索引来指示数组末尾的偏移量。 例如，-2 引用数组的第二个到最后一个元素。

function slice(start?: number, end?: number): T[]

参数

start

number

数组的指定部分的起始索引。 如果未定义 start，则切片从索引 0 开始。

end

number

数组指定部分的结束索引。 这是索引“end”处的元素的独占。 如果未定义 end，则切片将扩展到数组的末尾。

返回

T[]

继承自 Array.slice

some((value: T, index: number, array: T[]) => unknown, any)

确定指定的回调函数是否为数组的任何元素返回 true。

function some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean

参数

predicate

(value: T, index: number, array: T[]) => unknown

最多接受三个参数的函数。 某些方法调用数组中每个元素的谓词函数，直到谓词返回一个值，该值可强制为布尔值 true，或直到数组的末尾。

thisArg

any

此关键字可以在谓词函数中引用的对象。 如果省略 thisArg，则未定义将用作此值。

返回

boolean

继承自 Array.some

sort((a: T, b: T) => number)

就地对数组进行排序。 此方法将改变数组并返回对同一数组的引用。

function sort(compareFn?: (a: T, b: T) => number): PagedList<T>

参数

compareFn

(a: T, b: T) => number

用于确定元素顺序的函数。 如果第一个参数小于第二个参数，则返回负值;如果参数相等，则返回零;否则返回正值。 如果省略，则按升序 ASCII 字符顺序对元素进行排序。

[11,2,22,1].sort((a, b) => a - b)

返回

PagedList<T>

继承自 Array.sort

splice(number, number)

从数组中删除元素，并在必要时在其位置插入新元素，并返回已删除的元素。

function splice(start: number, deleteCount?: number): T[]

参数

start

number

数组中从零开始删除元素的位置。

deleteCount

number

要移除的元素数。

返回

T[]

包含已删除的元素的数组。

继承自 Array.splice

splice(number, number, T[])

从数组中删除元素，并在必要时在其位置插入新元素，并返回已删除的元素。

function splice(start: number, deleteCount: number, items: T[]): T[]

参数

start

number

数组中从零开始删除元素的位置。

deleteCount

number

要移除的元素数。

items

T[]

要插入数组中的元素代替已删除的元素。

返回

T[]

包含已删除的元素的数组。

继承自 Array.splice

toLocaleString()

返回数组的字符串表示形式。 元素使用其 toLocaleString 方法转换为字符串。

function toLocaleString(): string

返回

string

继承自 Array.toLocaleString

toString()

返回数组的字符串表示形式。

function toString(): string

返回

string

继承自 Array.toString

unshift(T[])

在数组的开头插入新元素，并返回数组的新长度。

function unshift(items: T[]): number

参数

items

T[]

要插入数组开头的元素。

返回

number

继承自 Array.unshift

values()

返回数组中值的可迭代值

function values(): IterableIterator<T>

返回

IterableIterator<T>

继承自 Array.values

[iterator]()

迭 代

function [iterator](): IterableIterator<T>

返回

IterableIterator<T>

继承自 Array.__@iterator@17744 的

[unscopables]()

返回一个对象，其属性在“with”语句中使用时将缺少值“true”。

function [unscopables](): { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }

返回

{ copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }

继承自 Array.__@unscopables@17746 的