Class ObjectViewsObjectsCursorIDPage

Hierarchy (View Summary)

ObjectsCursorIDPage<ObjectView>
- ObjectViewsObjectsCursorIDPage

Index

Constructors

Properties

options response body objects has_more total_count

Methods

getNextPage iterPages [asyncIterator] getPaginatedItems hasNextPage nextPageParams nextPageInfo

Constructors

constructor

new ObjectViewsObjectsCursorIDPage(
    client: APIClient,
    response: Response,
    body: ObjectsCursorIDPageResponse<ObjectView>,
    options: FinalRequestOptions,
): ObjectViewsObjectsCursorIDPage
Parameters
- client: APIClient
- response: Response
- body: ObjectsCursorIDPageResponse<ObjectView>
- options: FinalRequestOptions
Returns ObjectViewsObjectsCursorIDPage
Inherited from ObjectsCursorIDPage.constructor
- Defined in src/pagination.ts:769

Properties

`Protected`options

options: FinalRequestOptions

`Protected`response

response: Response

`Protected`body

body: unknown

objects

objects: ObjectView[]

has_more

has_more: boolean

total_count

total_count: number

Methods

getNextPage

getNextPage(): Promise<ObjectViewsObjectsCursorIDPage>
Returns Promise<ObjectViewsObjectsCursorIDPage>
Inherited from ObjectsCursorIDPage.getNextPage
- Defined in src/core.ts:702

iterPages

iterPages(): AsyncGenerator<ObjectViewsObjectsCursorIDPage>
Returns AsyncGenerator<ObjectViewsObjectsCursorIDPage>
Inherited from ObjectsCursorIDPage.iterPages
- Defined in src/core.ts:723

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<ObjectView>
Returns AsyncGenerator<ObjectView>
Inherited from ObjectsCursorIDPage.[asyncIterator]
- Defined in src/core.ts:733

getPaginatedItems

getPaginatedItems(): ObjectView[]
Returns ObjectView[]
Inherited from ObjectsCursorIDPage.getPaginatedItems
- Defined in src/pagination.ts:782

hasNextPage

hasNextPage(): boolean
Returns boolean
Inherited from ObjectsCursorIDPage.hasNextPage
- Defined in src/pagination.ts:786

nextPageParams

nextPageParams(): Partial<ObjectsCursorIDPageParams> | null
Returns Partial<ObjectsCursorIDPageParams> | null
Deprecated
Use nextPageInfo instead
Inherited from ObjectsCursorIDPage.nextPageParams
- Defined in src/pagination.ts:795

nextPageInfo

nextPageInfo(): PageInfo | null
Returns PageInfo | null
Inherited from ObjectsCursorIDPage.nextPageInfo
- Defined in src/pagination.ts:804