Skip to main content

PageOptions

popyt

popyt / Library Exports / PageOptions

Type Alias: PageOptions

PageOptions = object

Defined in: types/RetrievalService.ts:94

When retrieving a paginated entity, use these options to specify number, size, and location of pages you are requesting.

Properties​

maxPerPage?​

optional maxPerPage?: number

Defined in: types/RetrievalService.ts:103

The maximum number of items to include per page.

pages?​

optional pages?: number

Defined in: types/RetrievalService.ts:98

The number of pages to fetch.

pageToken?​

optional pageToken?: string

Defined in: types/RetrievalService.ts:108

The token of the page to fetch, retrieved from a previous call to the method returning a PaginatedResponse.