Class DevboxViewsDevboxesCursorIDPage

Hierarchy (View Summary)

DevboxesCursorIDPage<DevboxView>
- DevboxViewsDevboxesCursorIDPage

Index

Constructors

Properties

options response body devboxes has_more total_count

Methods

getNextPage iterPages [asyncIterator] getPaginatedItems hasNextPage nextPageParams nextPageInfo

Constructors

constructor

new DevboxViewsDevboxesCursorIDPage(
    client: APIClient,
    response: Response,
    body: DevboxesCursorIDPageResponse<DevboxView>,
    options: FinalRequestOptions,
): DevboxViewsDevboxesCursorIDPage
Parameters
- client: APIClient
- response: Response
- body: DevboxesCursorIDPageResponse<DevboxView>
- options: FinalRequestOptions
Returns DevboxViewsDevboxesCursorIDPage
Inherited from DevboxesCursorIDPage.constructor
- Defined in src/pagination.ts:103

Properties

`Protected`options

options: FinalRequestOptions

`Protected`response

response: Response

`Protected`body

body: unknown

devboxes

devboxes: DevboxView[]

has_more

has_more: boolean

total_count

total_count: number

Methods

getNextPage

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

iterPages

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

[asyncIterator]

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

getPaginatedItems

getPaginatedItems(): DevboxView[]
Returns DevboxView[]
Inherited from DevboxesCursorIDPage.getPaginatedItems
- Defined in src/pagination.ts:116

hasNextPage

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

nextPageParams

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

nextPageInfo

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