Skip to main content
Module

x/openai/core.ts>PagePromise

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
class PagePromise
implements AsyncIterable<Item>
import { PagePromise } from "https://deno.land/x/openai@v4.38.5/core.ts";

This subclass of Promise will resolve to an instantiated Page once the request completes.

It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:

for await (const item of client.items.list()) { console.log(item) }

Constructors

new
PagePromise(
client: APIClient,
request: Promise<APIResponseProps>,
Page: new (...args: ConstructorParameters<AbstractPage>) => PageClass,
)

Type Parameters

PageClass extends AbstractPage<Item>
optional
Item = ReturnType<PageClass["getPaginatedItems"]>[number]

Methods

[Symbol.asyncIterator]()

Allow auto-paginating iteration on an unawaited list call, eg:

for await (const item of client.items.list()) { console.log(item) }