Interface Page<T, R>`Template`

A page of results from a paginated API.

T The type of the items in the page. R The type of the API response.

interface Page<T, R = unknown> {
    data: T[];
    rawResponse: RawResponse;
    response: R;
    getNextPage(): Promise<Page<T, R>>;
    hasNextPage(): boolean;
    "[asyncIterator]"(): AsyncIterator<T, void, any>;
}

Type Parameters

T
R = unknown

Implements

AsyncIterable<T>

Index

Methods

getNextPage hasNextPage [asyncIterator]

Properties

data rawResponse response

Methods

getNextPage

getNextPage(): Promise<Page<T, R>>
Retrieves the next page

Returns Promise<Page<T, R>>
this

hasNextPage

hasNextPage(): boolean
Returns boolean
whether there is a next page to load

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T, void, any>
Returns AsyncIterator<T, void, any>
Implementation of AsyncIterable.[asyncIterator]

Properties

data

data: T[]

rawResponse

rawResponse: RawResponse

response

response: R