IPagedResource

Home > @gooddata/sdk-backend-spi > IPagedResource

IPagedResource interface

Interface to interact with paged asynchronous resources

Signature:

export interface IPagedResource<TItem> 

Properties

Property	Modifiers	Type	Description
cacheId?	readonly	string	(Optional)
items	readonly	TItem[]
limit	readonly	number
offset	readonly	number
totalCount	readonly	number

Methods

Method	Description
all()	Request all the pages merged in a single array.
allSorted(compareFn)	Request all the pages merged in a single array and sort them using the given comparator.
goTo(pageIndex)	Request a specific page of the resource
next()	Request next page of the resource