Class Paginator<Options, Settings, PageItem, PageExtra>

Type Parameters

Options
Settings
PageItem
PageExtra

Hierarchy

Paginator

Index

Constructors

Methods

generator getCurrentPage hasNextPage hasPrevPage next prev updateOptions

Constructors

constructor

new Paginator<Options, Settings, PageItem, PageExtra>(paginatable, options, settings): Paginator<Options, Settings, PageItem, PageExtra>
Type Parameters
- Options
- Settings
- PageItem
- PageExtra
Parameters
- paginatable: Paginatable<Options, Settings, PageItem, PageExtra>
- options: Options
- settings: Settings
Returns Paginator<Options, Settings, PageItem, PageExtra>
- Defined in packages/rest-client/src/tools/paginate.ts:20

Methods

generator

generator(): AsyncGenerator<PaginatedList<PageItem, PageExtra>, void, unknown>
Returns AsyncGenerator<PaginatedList<PageItem, PageExtra>, void, unknown>
- Defined in packages/rest-client/src/tools/paginate.ts:72

getCurrentPage

getCurrentPage(): null | PaginatedList<PageItem, PageExtra>
Returns null | PaginatedList<PageItem, PageExtra>
- Defined in packages/rest-client/src/tools/paginate.ts:46

hasNextPage

hasNextPage(): boolean
Returns boolean
- Defined in packages/rest-client/src/tools/paginate.ts:38

hasPrevPage

hasPrevPage(): boolean
Returns boolean
- Defined in packages/rest-client/src/tools/paginate.ts:42

next

next(): Promise<null | PaginatedList<PageItem, PageExtra>>
Returns Promise<null | PaginatedList<PageItem, PageExtra>>
- Defined in packages/rest-client/src/tools/paginate.ts:50

prev

prev(): Promise<null | PaginatedList<PageItem, PageExtra>>
Returns Promise<null | PaginatedList<PageItem, PageExtra>>
- Defined in packages/rest-client/src/tools/paginate.ts:63

updateOptions

updateOptions(options): void
Parameters
- options: Options
Returns void
- Defined in packages/rest-client/src/tools/paginate.ts:30

Generated using TypeDoc