Class Page<Item>

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

Type Parameters

  • Item

Hierarchy (view full)

Implements

Constructors

constructor

Properties

body data object options response

Methods

[asyncIterator] getNextPage getPaginatedItems hasNextPage iterPages nextPageInfo nextPageParams

Constructors

constructor

  • new Page<Item>(client, response, body, options): OpenAIClient.Page<Item>

  • Type Parameters

    • Item

    Parameters

    • client: APIClient
    • response: Response
    • body: PageResponse<Item>
    • options: FinalRequestOptions

    Returns OpenAIClient.Page<Item>

Properties

Protectedbody

body: unknown

data

data: Item[]

object

object: string

Protectedoptions

options: FinalRequestOptions<unknown>

Protectedresponse

response: Response

Methods

[asyncIterator]

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

  • Returns AsyncGenerator<Item, any, unknown>

getNextPage

getPaginatedItems

  • getPaginatedItems(): Item[]

  • Returns Item[]

hasNextPage

  • hasNextPage(): boolean

  • Returns boolean

iterPages

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

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

nextPageInfo

  • nextPageInfo(): null

  • Returns null

nextPageParams

  • nextPageParams(): null

  • This page represents a response that isn't actually paginated at the API level so there will never be any next page params.

    Returns null

Settings

Member Visibility

On This Page

Constructors
Properties
Methods