@ralphschuler.ai function caller.index.<internal>.AbstractPage

Class: AbstractPage<Item>

index.<internal>.AbstractPage

Type parameters

Name
Item

Hierarchy

• AbstractPage

  ↳ Page

  ↳ CursorPage

Implements

• AsyncIterable<Item>

Table of contents

Constructors

• constructor

Properties

• #private
• body
• options
• response

Methods

• [asyncIterator]
• getNextPage
• getPaginatedItems
• hasNextPage
• iterPages
• nextPageInfo
• nextPageParams

Constructors

constructor

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

Type parameters

Name
Item

Parameters

Name	Type
client	APIClient
response	Response
body	unknown
options	FinalRequestOptions<Readable | Record<string, unknown>>

Returns

AbstractPage<Item>

Defined in

node_modules/openai/core.d.ts:139

Properties

#private

• Private #private: any

Defined in

node_modules/openai/core.d.ts:135

---

body

• Protected body: unknown

Defined in

node_modules/openai/core.d.ts:138

---

options

• Protected options: FinalRequestOptions<Readable | Record<string, unknown>>

Defined in

node_modules/openai/core.d.ts:136

---

response

• Protected response: Response

Defined in

node_modules/openai/core.d.ts:137

Methods

[asyncIterator]

▸ [asyncIterator](): AsyncGenerator<Awaited<Item>, void, unknown>

Returns

AsyncGenerator<Awaited<Item>, void, unknown>

Implementation of

AsyncIterable.[asyncIterator]

Defined in

node_modules/openai/core.d.ts:149

---

getNextPage

▸ getNextPage(): Promise<AbstractPage<Item>>

Returns

Promise<AbstractPage<Item>>

Defined in

node_modules/openai/core.d.ts:147

---

getPaginatedItems

▸ getPaginatedItems(): Item[]

Returns

Item[]

Defined in

node_modules/openai/core.d.ts:145

---

hasNextPage

▸ hasNextPage(): boolean

Returns

boolean

Defined in

node_modules/openai/core.d.ts:146

---

iterPages

▸ iterPages(): AsyncGenerator<AbstractPage<Item>, void, unknown>

Returns

AsyncGenerator<AbstractPage<Item>, void, unknown>

Defined in

node_modules/openai/core.d.ts:148

---

nextPageInfo

▸ nextPageInfo(): null | PageInfo

Returns

null | PageInfo

Defined in

node_modules/openai/core.d.ts:144

---

nextPageParams

▸ nextPageParams(): null | Partial<Record<string, unknown>>

Returns

null | Partial<Record<string, unknown>>

Deprecated

Use nextPageInfo instead

Defined in

node_modules/openai/core.d.ts:143