@camunda8/orchestration-cluster-api
    Preparing search index...

    Interface SearchPaginateOptions<TData>

    Options for search*.paginate(...): page controls + per-call forwarding.

    interface SearchPaginateOptions<TData> {
        consistency?: ConsistencyOptions<TData>;
        maxPages?: number;
        mode?: PaginationMode;
        signal?: AbortSignal;
    }

    Type Parameters

    • TData

    Hierarchy (View Summary)

    Index
    consistency?: ConsistencyOptions<TData>

    Eventual-consistency controls forwarded to the underlying search call. Defaults to { waitUpToMs: 0 } (ignore eventual consistency) when omitted.

    Only the first page honours this window: once paging is under way an empty page is a legitimate end-of-results, not a not-yet-consistent read, so subsequent (and exhaustion-probe) fetches always use { waitUpToMs: 0 }. Waiting on those would make the terminal fetch of an exactly-full or empty result set block for the whole window and then throw.

    maxPages?: number

    Safety cap on pages fetched (default: unbounded). A non-positive value (0 or negative) fetches no pages at all — the cap is enforced before the first request, so it is always honoured exactly.

    How to advance. auto prefers a cursor, falls back to offset.

    signal?: AbortSignal

    Abort between pages; a fired signal stops further fetches.