Class Page<Item>

Note: no pagination actually occurs yet, this is for forwards-compatibility.

Type Parameters

  • Item

Hierarchy

  • AbstractPage<Item>
    • Page

Implements

Constructors

constructor

Properties

body data object options response

Methods

[asyncIterator] getNextPage getPaginatedItems hasNextPage iterPages nextPageRequestOptions

Constructors

constructor

Properties

Protectedbody

body: unknown

data

data: Item[]

object

object: string

Protectedoptions

options: FinalRequestOptions

Protectedresponse

response: Response

Methods

[asyncIterator]

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

  • Returns AsyncGenerator<Item, any, any>

getNextPage

getPaginatedItems

  • getPaginatedItems(): Item[]

  • Returns Item[]

hasNextPage

  • hasNextPage(): boolean

  • Returns boolean

iterPages

  • iterPages(): AsyncGenerator<OpenAIClient.Page<Item>, any, any>

  • Returns AsyncGenerator<OpenAIClient.Page<Item>, any, any>

nextPageRequestOptions

  • nextPageRequestOptions(): null | PageRequestOptions

  • Returns null | PageRequestOptions

Settings

Member Visibility

On This Page

Constructors
Properties
Methods