@ibm-cloud/cloudant/cloudant/features/pagination/allDocsBasePageIterator.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.
 */
import { default as CloudantV1, AllDocsResult, DocsResultRow, Response } from '../../v1';
import { KeyPageIterator } from './keyPageIterator';
export declare abstract class AllDocsBasePageIterator<P extends CloudantV1.PostAllDocsParams | CloudantV1.PostPartitionAllDocsParams | CloudantV1.PostDesignDocsParams> extends KeyPageIterator<P, AllDocsResult, DocsResultRow> {
    /**
     * Setting start key doc ID is a no-op for all_docs based paging where
     * key is the same as id.
     */
    protected setNextKeyId(startKeyDocId: string): void;
    protected getItems(result: AllDocsResult): Array<DocsResultRow>;
    protected abstract nextRequestFunction(): (params: P) => Promise<Response<AllDocsResult>>;
    protected checkBoundary(penultimateItem: DocsResultRow, lastItem: DocsResultRow): any;
    protected getValidateParamsAbsentErrorMessage(paramName: any): string;
}