@ibm-cloud/cloudant/cloudant/features/pagination/pager.d.ts

IBM Cloudant Node.js SDK

/**
 * © Copyright IBM Corporation 2025. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * Interface for pagination of database operations.
 *
 * Use the static methods to instantiate a Pager instance for
 * the required operation.
 *
 * @param <I> the item type of the page rows.
 */
export interface Pager<I> {
    hasNext(): boolean;
    getNext(): Promise<ReadonlyArray<I>>;
    getAll(): Promise<ReadonlyArray<I>>;
}