Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.CursorPage

github-actions edited this page Nov 26, 2023 · 1 revision

Class: CursorPage<Item>

<internal>.OpenAI.CursorPage

Type parameters

Name Type
Item extends Object

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

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

Type parameters

Name Type
Item extends Object

Parameters

Name Type
client APIClient
response Response
body CursorPageResponse<Item>
options FinalRequestOptions

Returns

CursorPage<Item>

Overrides

AbstractPage.constructor

Defined in

node_modules/openai/pagination.d.ts:38

Properties

#private

Private #private: any

Inherited from

AbstractPage.#private

Defined in

node_modules/openai/core.d.ts:135


body

Protected body: unknown

Inherited from

AbstractPage.body

Defined in

node_modules/openai/core.d.ts:138


data

data: Item[]

Implementation of

CursorPageResponse.data

Defined in

node_modules/openai/pagination.d.ts:37


options

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

Inherited from

AbstractPage.options

Defined in

node_modules/openai/core.d.ts:136


response

Protected response: Response

Inherited from

AbstractPage.response

Defined in

node_modules/openai/core.d.ts:137

Methods

[asyncIterator]

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

Returns

AsyncGenerator<Awaited<Item>, void, unknown>

Inherited from

AbstractPage.[asyncIterator]

Defined in

node_modules/openai/core.d.ts:149


getNextPage

getNextPage(): Promise<CursorPage<Item>>

Returns

Promise<CursorPage<Item>>

Inherited from

AbstractPage.getNextPage

Defined in

node_modules/openai/core.d.ts:147


getPaginatedItems

getPaginatedItems(): Item[]

Returns

Item[]

Overrides

AbstractPage.getPaginatedItems

Defined in

node_modules/openai/pagination.d.ts:39


hasNextPage

hasNextPage(): boolean

Returns

boolean

Inherited from

AbstractPage.hasNextPage

Defined in

node_modules/openai/core.d.ts:146


iterPages

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

Returns

AsyncGenerator<AbstractPage<Item>, void, unknown>

Inherited from

AbstractPage.iterPages

Defined in

node_modules/openai/core.d.ts:148


nextPageInfo

nextPageInfo(): null | PageInfo

Returns

null | PageInfo

Overrides

AbstractPage.nextPageInfo

Defined in

node_modules/openai/pagination.d.ts:41


nextPageParams

nextPageParams(): null | Partial<CursorPageParams>

Returns

null | Partial<CursorPageParams>

Deprecated

Use nextPageInfo instead

Overrides

AbstractPage.nextPageParams

Defined in

node_modules/openai/pagination.d.ts:40

Typescript Libraries

Modules

Namespaces

Clone this wiki locally