@earth-app/collegedb
    Preparing search index...

    Interface GlobalAllShardsOptions<T>

    Options for global all-shards merge/sort/pagination.

    1.1.4

    interface GlobalAllShardsOptions<T = Record<string, unknown>> {
        batchSize?: number;
        comparator?: (left: T, right: T) => number;
        filter?: (row: T) => boolean;
        includeTotal?: boolean;
        limit?: number;
        offset?: number;
        sortBy?: keyof T | ((row: T) => unknown);
        sortDirection?: "asc" | "desc";
    }

    Type Parameters

    • T = Record<string, unknown>
    Index
    batchSize? comparator? filter? includeTotal? limit? offset? sortBy? sortDirection?
    batchSize?: number

    Number of concurrent shard queries to run at once (default: 50).

    comparator?: (left: T, right: T) => number

    Optional custom comparator; takes precedence over sortBy.

    filter?: (row: T) => boolean

    Optional global row filter applied before sort/paginate.

    includeTotal?: boolean

    When true, record the total number of rows that matched (after filter, before offset/limit) on meta.total. Useful for paginated UIs.

    1.2.4

    limit?: number

    Maximum rows to return after global merge/sort.

    offset?: number

    Number of rows to skip after global merge/sort (default: 0).

    sortBy?: keyof T | ((row: T) => unknown)

    Field name or selector used for global sorting.

    sortDirection?: "asc" | "desc"

    Sort direction for sortBy (default: asc).

    Settings
    Member Visibility

    On This Page
    Properties