Paginator | polympics

Utility for getting paginated responses from the API.

Type parameters

Type

Hierarchy

Paginator

Index

Constructors

constructor

Properties

Methods

nextPage

Constructors

constructor

new Paginator<Type>(getPage: (params: Record<string, any>) => Promise<PaginatedResponse<Type>>): Paginator<Type>

- Defined in polympics/paginator.ts:7
Type parameters
- Type
Parameters
- getPage: (params: Record<string, any>) => Promise<PaginatedResponse<Type>>
  - - (params: Record<string, any>): Promise<PaginatedResponse<Type>>
    - Parameters
      - params: Record<string, any>
      Returns Promise<PaginatedResponse<Type>>
Returns Paginator<Type>

Properties

getPage

getPage: (params: Record<string, any>) => Promise<PaginatedResponse<Type>>

Type declaration

- (params: Record<string, any>): Promise<PaginatedResponse<Type>>
- Parameters
  - params: Record<string, any>
  Returns Promise<PaginatedResponse<Type>>

lastPage

lastPage: number

nextPageDone

nextPageDone: boolean

Methods

nextPage

nextPage(): Promise<Type[]>

- Defined in polympics/paginator.ts:23
Utility to get the next page.

Note that calls to getPage will not change the next page that this gets. Once all pages have been gotten, this will return an empty array (but won't invoke the API).

Returns Promise<Type[]>

Generated using TypeDoc