Interface Paginate<T>

Type Parameters

T

Hierarchy

Paginate

Index

Methods

nextPage prevPage toPage

Methods

nextPage

nextPage(): Promise<T & Paginate<T>>
Paginate to the next page, does not replace the object.

Returns Promise<T & Paginate<T>>
The next page of search results.
- Defined in src/types.ts:20

prevPage

prevPage(): Promise<T & Paginate<T>>
Paginate to the previous page, does not replace the object.

Returns Promise<T & Paginate<T>>
The previous page of search results.
- Defined in src/types.ts:25

toPage

toPage(page): Promise<T & Paginate<T>>
Paginate to a specific page, does not replace the object.
Parameters
- page: number
  
  The page to navigate to. Must be an integer greater than 0.
Returns Promise<T & Paginate<T>>
The specified page of search results.
- Defined in src/types.ts:31

Generated using TypeDoc