Class PaginatedResponse<T>

Wraps a paginated API response, providing methods to navigate between pages

The properties of the current page's data are directly accessible on instances of this class

Type Parameters

T
The type of the data within the paginated response

Index

Constructors

Methods

Constructors

constructor

new PaginatedResponse<T>(
    data: T,
    nextUrl: null | string,
    prevUrl: null | string,
    requester: Requester,
): PaginatedResponse<T>
Type Parameters
- T
Parameters
- data: T
- nextUrl: null | string
- prevUrl: null | string
- requester: Requester
Returns PaginatedResponse<T>
- Defined in src/client/paginated.ts:17

Methods

next

next(): Promise<null | PaginatedResponse<T> & T>
Fetches the next page of results

Returns Promise<null | PaginatedResponse<T> & T>
A promise that resolves to the next page, or null if there is no next page
- Defined in src/client/paginated.ts:56

prev

prev(): Promise<null | PaginatedResponse<T> & T>
Fetches the previous page of results

Returns Promise<null | PaginatedResponse<T> & T>
A promise that resolves to the previous page, or null if there is no next page
- Defined in src/client/paginated.ts:64