Back to Node Auth0

Interface Page<T, R>Template

docs/interfaces/management.Page.html

5.9.11.7 KB
Original Source

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, unknown>;
}

Type Parameters

  • T
  • R = unknown

Implements

  • AsyncIterable<T>

Index

Methods

getNextPagehasNextPage[asyncIterator]

Properties

datarawResponseresponse

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, unknown>

Returns AsyncIterator<T, void, unknown>

Properties

data

data: T[]

rawResponse

rawResponse: RawResponse

response

response: R

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Methods getNextPagehasNextPage[asyncIterator] Properties datarawResponseresponse