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

    Interface EffectPaginateOptions<TData>

    Options for the Effect client's .paginate.

    interface EffectPaginateOptions<TData = unknown> {
        consistency?: ConsistencyOptions<TData>;
        maxPages?: number;
        mode?: PaginationMode;
    }

    Type Parameters

    • TData = unknown
    Index
    consistency?: ConsistencyOptions<TData>

    Eventual-consistency controls forwarded to the underlying search call. Defaults to { waitUpToMs: 0 }. Only the first page honours this window: once paging is under way an empty page is end-of-results, not a not-yet-consistent read.

    maxPages?: number

    Safety cap on pages fetched (default: unbounded). A non-positive value fetches no pages at all — the cap is enforced before the first request.

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