PagedList interface

Reference

Package:: azure-devops-extension-api

A list that contains a single page of results from a query.

Extends: Array<T>

Properties

A string that can be passed to the same endpoint that returned this PagedList in order to retrieve the next page of results.

Inherited Properties

length

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited Methods

at(number)
concat((T \| ConcatArray<T>)[])	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat(ConcatArray<T>[])	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
copyWithin(number, number, number)	Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
entries()	Returns an iterable of key, value pairs for every entry in the array
every((value: T, index: number, array: T[]) => unknown, any)	Determines whether all the members of an array satisfy the specified test.
every<S>((value: T, index: number, array: T[]) => value, any)	Determines whether all the members of an array satisfy the specified test.
fill(T, number, number)	Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
filter((value: T, index: number, array: T[]) => unknown, any)	Returns the elements of an array that meet the condition specified in a callback function.
filter<S>((value: T, index: number, array: T[]) => value, any)	Returns the elements of an array that meet the condition specified in a callback function.
find((value: T, index: number, obj: T[]) => unknown, any)
find<S>((this: void, value: T, index: number, obj: T[]) => value, any)	Returns the value of the first element in the array where predicate is true, and undefined otherwise.
findIndex((value: T, index: number, obj: T[]) => unknown, any)	Returns the index of the first element in the array where predicate is true, and -1 otherwise.
flat<A, D>(A, D)	Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
flatMap<U, This>((this: This, value: T, index: number, array: T[]) => U \| (readonly U[]), This)	Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.
forEach((value: T, index: number, array: T[]) => void, any)	Performs the specified action for each element in an array.
includes(T, number)	Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(T, number)	Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
join(string)	Adds all the elements of an array into a string, separated by the specified separator string.
keys()	Returns an iterable of keys in the array
lastIndexOf(T, number)	Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
map<U>((value: T, index: number, array: T[]) => U, any)	Calls a defined callback function on each element of an array, and returns an array that contains the results.
pop()	Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push(T[])	Appends new elements to the end of an array, and returns the new length of the array.
reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)
reduce<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, T)
reduceRight<U>((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, U)	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reverse()	Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift()	Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice(number, number)	Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
some((value: T, index: number, array: T[]) => unknown, any)	Determines whether the specified callback function returns true for any element of an array.
sort((a: T, b: T) => number)	Sorts an array in place. This method mutates the array and returns a reference to the same array.
splice(number, number)	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice(number, number, T[])	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
toLocaleString()	Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
toString()	Returns a string representation of an array.
unshift(T[])	Inserts new elements at the start of an array, and returns the new length of the array.
values()	Returns an iterable of values in the array
[iterator]()	Iterator
[unscopables]()	Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Property Details

continuationToken

A string that can be passed to the same endpoint that returned this PagedList in order to retrieve the next page of results.

continuationToken: null | string

Property Value

null | string

Inherited Property Details

length

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

length: number

Property Value

number

Inherited From Array.length

Inherited Method Details

at(number)

function at(index: number): undefined | T

Parameters

index: number

Returns

undefined | T

Inherited From Array.at

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

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

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

Parameters

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

Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited From Array.concat

concat(ConcatArray<T>[])

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

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

Parameters

items: ConcatArray<T>[]

Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited From Array.concat

copyWithin(number, number, number)

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

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

Parameters

target: number

If target is negative, it is treated as length+target where length is the length of the array.

start: number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end: number

If not specified, length of the this object is used as its default value.

Returns

PagedList<T>

Inherited From Array.copyWithin

entries()

Returns an iterable of key, value pairs for every entry in the array

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

Returns

IterableIterator<[number, T]>

Inherited From Array.entries

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

Determines whether all the members of an array satisfy the specified test.

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

Parameters

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

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg: any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited From Array.every

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

Determines whether all the members of an array satisfy the specified test.

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

Parameters

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

thisArg: any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this

Inherited From Array.every

fill(T, number, number)

Changes all array elements from start to end index to a static value and returns the modified array

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

Parameters

value: T

value to fill array section with

start: number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end: number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

PagedList<T>

Inherited From Array.fill

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

Returns the elements of an array that meet the condition specified in a callback function.

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

Parameters

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

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg: any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

T[]

Inherited From Array.filter

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

Returns the elements of an array that meet the condition specified in a callback function.

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

Parameters

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

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg: any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited From 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

Parameters

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

thisArg: any

Returns

undefined | T

Inherited From Array.find

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

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

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

Parameters

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

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg: any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Inherited From Array.find

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

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

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

Parameters

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

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg: any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited From Array.findIndex

flat<A, D>(A, D)

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

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

Parameters

this: A

depth: D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited From Array.flat

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

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

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

Parameters

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

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg: This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited From Array.flatMap

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

Performs the specified action for each element in an array.

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

Parameters

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

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg: any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Inherited From Array.forEach

includes(T, number)

Determines whether an array includes a certain element, returning true or false as appropriate.

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

Parameters

searchElement: T

The element to search for.

fromIndex: number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited From Array.includes

indexOf(T, number)

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

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

Parameters

searchElement: T

The value to locate in the array.

fromIndex: number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited From Array.indexOf

join(string)

Adds all the elements of an array into a string, separated by the specified separator string.

function join(separator?: string): string

Parameters

separator: string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited From Array.join

keys()

Returns an iterable of keys in the array

function keys(): IterableIterator<number>

Returns

IterableIterator<number>

Inherited From Array.keys

lastIndexOf(T, number)

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

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

Parameters

searchElement: T

The value to locate in the array.

fromIndex: number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited From Array.lastIndexOf

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

Calls a defined callback function on each element of an array, and returns an array that contains the results.

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

Parameters

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

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg: any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited From Array.map

pop()

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

function pop(): undefined | T

Returns

undefined | T

Inherited From Array.pop

push(T[])

Appends new elements to the end of an array, and returns the new length of the array.

function push(items: T[]): number

Parameters

items: T[]

New elements to add to the array.

Returns

number

Inherited From Array.push

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

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

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

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

Inherited From 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

Parameters

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

initialValue: T

Returns

Inherited From 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

Parameters

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

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue: U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

Inherited From Array.reduce

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

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

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

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

Inherited From 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

Parameters

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

initialValue: T

Returns

Inherited From 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

Parameters

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

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue: U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

Inherited From Array.reduceRight

reverse()

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

function reverse(): T[]

Returns

T[]

Inherited From Array.reverse

shift()

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

function shift(): undefined | T

Returns

undefined | T

Inherited From Array.shift

slice(number, number)

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

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

Parameters

start: number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end: number

The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

T[]

Inherited From Array.slice

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

Determines whether the specified callback function returns true for any element of an array.

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

Parameters

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

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg: any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited From Array.some

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

Sorts an array in place. This method mutates the array and returns a reference to the same array.

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

Parameters

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

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

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

Returns

PagedList<T>

Inherited From Array.sort

splice(number, number)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

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

Parameters

start: number

The zero-based location in the array from which to start removing elements.

deleteCount: number

The number of elements to remove.

Returns

T[]

An array containing the elements that were deleted.

Inherited From Array.splice

splice(number, number, T[])

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

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

Parameters

start: number

The zero-based location in the array from which to start removing elements.

deleteCount: number

The number of elements to remove.

items: T[]

Elements to insert into the array in place of the deleted elements.

Returns

T[]

An array containing the elements that were deleted.

Inherited From Array.splice

toLocaleString()

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

function toLocaleString(): string

Returns

string

Inherited From Array.toLocaleString

toString()

Returns a string representation of an array.

function toString(): string

Returns

string

Inherited From Array.toString

unshift(T[])

Inserts new elements at the start of an array, and returns the new length of the array.

function unshift(items: T[]): number

Parameters

items: T[]

Elements to insert at the start of the array.

Returns

number

Inherited From Array.unshift

values()

Returns an iterable of values in the array

function values(): IterableIterator<T>

Returns

IterableIterator<T>

Inherited From Array.values

[iterator]()

Iterator

function [iterator](): IterableIterator<T>

Returns

IterableIterator<T>

Inherited From Array.__@iterator@17793

[unscopables]()

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

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

Returns

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

Inherited From Array.__@unscopables@17795

Share via

PagedList interface

Properties

Inherited Properties

Inherited Methods

Property Details

continuationToken

Property Value

Inherited Property Details

length

Property Value

Inherited Method Details

at(number)

Parameters

Returns

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

Parameters

Returns

concat(ConcatArray<T>[])

Parameters

Returns

copyWithin(number, number, number)

Parameters

Returns

entries()

Returns

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

Parameters

Returns

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

Parameters

Returns

fill(T, number, number)

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

flat<A, D>(A, D)

Parameters

Returns

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

Parameters

Returns

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

Parameters

includes(T, number)

Parameters

Returns

indexOf(T, number)

Parameters

Returns

join(string)

Parameters

Returns

keys()

Returns

lastIndexOf(T, number)

Parameters

Returns

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

Parameters

Returns

pop()

Returns

push(T[])

Parameters

Returns