PagedAsyncIterableIterator
@trimblecloudplatform/trimblecloud.processing
@trimblecloudplatform/trimblecloud.processing / PagedAsyncIterableIterator
Interface: PagedAsyncIterableIterator<T>
Defined in: src/models/pagedAsyncIterableIterator.ts:8
Interface for an async iterator that handles pagination
Extends
AsyncIterableIterator<T>
Type Parameters
T
T
Methods
[asyncIterator]()
[asyncIterator]():
AsyncIterableIterator<T>
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:42
Returns
AsyncIterableIterator<T>
Inherited from
AsyncIterableIterator.[asyncIterator]
currentPage()
currentPage():
T[]
Defined in: src/models/pagedAsyncIterableIterator.ts:17
Get the current page of results
Returns
T[]
getMetadata()
getMetadata():
object
Defined in: src/models/pagedAsyncIterableIterator.ts:22
Get pagination metadata from the last response
Returns
object
currentPage
currentPage:
number
perPage
perPage:
number
totalEntries
totalEntries:
number
totalPages
totalPages:
number
next()
next(…
args):Promise<IteratorResult<T,any>>
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:32
Parameters
args
[] | [undefined]
Returns
Promise<IteratorResult<T, any>>
Inherited from
AsyncIterableIterator.next
return()?
optionalreturn(value?):Promise<IteratorResult<T,any>>
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33
Parameters
value?
any
Returns
Promise<IteratorResult<T, any>>
Inherited from
AsyncIterableIterator.return
throw()?
optionalthrow(e?):Promise<IteratorResult<T,any>>
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34
Parameters
e?
any
Returns
Promise<IteratorResult<T, any>>
Inherited from
AsyncIterableIterator.throw
toArray()
toArray():
Promise<T[]>
Defined in: src/models/pagedAsyncIterableIterator.ts:12
Get all remaining items as an array
Returns
Promise<T[]>