Class DevboxSnapshotViewsDiskSnapshotsCursorIDPage

Hierarchy (View Summary)

DiskSnapshotsCursorIDPage<DevboxSnapshotView>
- DevboxSnapshotViewsDiskSnapshotsCursorIDPage

Index

Constructors

Properties

options response body snapshots has_more total_count

Methods

getNextPage iterPages [asyncIterator] getPaginatedItems hasNextPage nextPageParams nextPageInfo

Constructors

constructor

new DevboxSnapshotViewsDiskSnapshotsCursorIDPage(
    client: APIClient,
    response: Response,
    body: DiskSnapshotsCursorIDPageResponse<DevboxSnapshotView>,
    options: FinalRequestOptions,
): DevboxSnapshotViewsDiskSnapshotsCursorIDPage
Parameters
- client: APIClient
- response: Response
- body: DiskSnapshotsCursorIDPageResponse<DevboxSnapshotView>
- options: FinalRequestOptions
Returns DevboxSnapshotViewsDiskSnapshotsCursorIDPage
Inherited from DiskSnapshotsCursorIDPage.constructor
- Defined in src/pagination.ts:251

Properties

`Protected`options

options: FinalRequestOptions

`Protected`response

response: Response

`Protected`body

body: unknown

snapshots

snapshots: DevboxSnapshotView[]

has_more

has_more: boolean

total_count

total_count: number

Methods

getNextPage

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

iterPages

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

[asyncIterator]

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

getPaginatedItems

getPaginatedItems(): DevboxSnapshotView[]
Returns DevboxSnapshotView[]
Inherited from DiskSnapshotsCursorIDPage.getPaginatedItems
- Defined in src/pagination.ts:264

hasNextPage

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

nextPageParams

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

nextPageInfo

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