Skip to content

Interface: PageInfo

lists/types/PageInfo.PageInfo

PageInfo contains meta information on pagination returned by the server. It is mostly used by the Paginator part of the :js:class:Client.

Properties

count

count: number

The total number of items in the remote array-- that is, over every page the server can return, what is the total number of items that will be returned? Not every API supports returning this, so its use is minimized in providence.

Defined in

src/base/lists/types/PageInfo.ts:11


size

size: number

The size of the page that the server is returning-- not how many items are in it, but how many it would return if returning a full page. Like count, not available for every API, and so not heavily relied on in Providence.

Defined in

src/base/lists/types/PageInfo.ts:16