import { FinalRequestOptions } from "../internal/request-options.js"; import { type BaseBeeperDesktop } from "../client.js"; import { APIPromise } from "./api-promise.js"; import { type APIResponseProps } from "../internal/parse.js"; export type PageRequestOptions = Pick; export declare abstract class AbstractPage implements AsyncIterable { #private; protected options: FinalRequestOptions; protected response: Response; protected body: unknown; constructor(client: BaseBeeperDesktop, response: Response, body: unknown, options: FinalRequestOptions); abstract nextPageRequestOptions(): PageRequestOptions | null; abstract getPaginatedItems(): Item[]; hasNextPage(): boolean; getNextPage(): Promise; iterPages(): AsyncGenerator; [Symbol.asyncIterator](): AsyncGenerator; } /** * This subclass of Promise will resolve to an instantiated Page once the request completes. * * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg: * * for await (const item of client.items.list()) { * console.log(item) * } */ export declare class PagePromise, Item = ReturnType[number]> extends APIPromise implements AsyncIterable { constructor(client: BaseBeeperDesktop, request: Promise, Page: new (...args: ConstructorParameters) => PageClass); /** * Allow auto-paginating iteration on an unawaited list call, eg: * * for await (const item of client.items.list()) { * console.log(item) * } */ [Symbol.asyncIterator](): AsyncGenerator; } export interface CursorSearchResponse { items: Array; hasMore: boolean; oldestCursor: string | null; newestCursor: string | null; } export interface CursorSearchParams { cursor?: string | null; direction?: string | null; limit?: number | null; } export declare class CursorSearch extends AbstractPage implements CursorSearchResponse { items: Array; hasMore: boolean; oldestCursor: string | null; newestCursor: string | null; constructor(client: BaseBeeperDesktop, response: Response, body: CursorSearchResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } export interface CursorNoLimitResponse { items: Array; hasMore: boolean; oldestCursor: string | null; newestCursor: string | null; } export interface CursorNoLimitParams { cursor?: string | null; direction?: string | null; } export declare class CursorNoLimit extends AbstractPage implements CursorNoLimitResponse { items: Array; hasMore: boolean; oldestCursor: string | null; newestCursor: string | null; constructor(client: BaseBeeperDesktop, response: Response, body: CursorNoLimitResponse, options: FinalRequestOptions); getPaginatedItems(): Item[]; hasNextPage(): boolean; nextPageRequestOptions(): PageRequestOptions | null; } //# sourceMappingURL=pagination.d.ts.map