Class Pager<TResource, TParams>`Abstract`

Abstract base class for all pager implementations. Provides common pagination functionality for list operations.

Abstract

Type Parameters

TResource
The type of resource being paginated
TParams extends {
start?: string;
}
The type of parameters for the list operation

Hierarchy (view full)

Pager

Index

Constructors

Properties

client hasNextPage pageContext params

Methods

getAll getNext hasNext

Constructors

constructor

new Pager<TResource, TParams>(client, params?): Pager<TResource, TParams>
Construct a Pager object.
Type Parameters
- TResource
- TParams extends {
  start?: string;
  }
Parameters
- client: WatsonXAI
  The service client instance
- Optional params: TParams
  The parameters to be passed to the list operation
Returns Pager<TResource, TParams>
Throws
If params.start is set (pagination should be handled internally)
- Defined in vml_v1.ts:7105

Properties

`Protected` client

client: WatsonXAI

`Protected` hasNextPage

hasNextPage: boolean

`Protected` pageContext

pageContext: {
next: undefined | string;
}

Type declaration

next: undefined | string

`Protected` params

params: TParams

Methods

getAll

getAll(): Promise<TResource[]>
Returns all results by repeatedly invoking getNext() until all pages of results have been retrieved.

Returns Promise<TResource[]>
A Promise that resolves to an array of all resources
- Defined in vml_v1.ts:7141

`Abstract` getNext

getNext(): Promise<TResource[]>
Abstract method to fetch the next page of results. Must be implemented by concrete pager classes.

Returns Promise<TResource[]>
A Promise that resolves to an array of resources

Abstract
Throws
If no more results are available
- Defined in vml_v1.ts:7133

hasNext

hasNext(): boolean
Returns true if there are potentially more results to be retrieved by invoking getNext().

Returns boolean
True if there are more results available, false otherwise
- Defined in vml_v1.ts:7121