Class CursorPage<Item>

Type Parameters

  • Item extends {
        id: string;
    }

Hierarchy (view full)

Implements

Constructors

constructor

Properties

body data options response

Methods

[asyncIterator] getNextPage getPaginatedItems hasNextPage iterPages nextPageInfo nextPageParams

Constructors

constructor

  • new CursorPage<Item>(client, response, body, options): CursorPage<Item>

  • Type Parameters

    • Item extends {
          id: string;
      }

    Parameters

    Returns CursorPage<Item>

Properties

Protectedbody

body: unknown

data

data: Item[]

Protectedoptions

options: FinalRequestOptions<unknown>

Protectedresponse

response: Response

Methods

[asyncIterator]

  • [asyncIterator](): AsyncGenerator<Item, any, unknown>

  • Returns AsyncGenerator<Item, any, unknown>

getNextPage

  • getNextPage(): Promise<CursorPage<Item>>

  • Returns Promise<CursorPage<Item>>

getPaginatedItems

  • getPaginatedItems(): Item[]

  • Returns Item[]

hasNextPage

  • hasNextPage(): boolean

  • Returns boolean

iterPages

  • iterPages(): AsyncGenerator<CursorPage<Item>, any, unknown>

  • Returns AsyncGenerator<CursorPage<Item>, any, unknown>

nextPageInfo

  • nextPageInfo(): null | PageInfo

  • Returns null | PageInfo

nextPageParams

  • nextPageParams(): null | Partial<CursorPageParams>

  • Returns null | Partial<CursorPageParams>

    Deprecated

    Use nextPageInfo instead

Settings

Member Visibility

On This Page

Constructors
Properties
Methods