Libraries v5.0.0
    Preparing search index...

    Interface CompositeCursorOptions<S>

    Opt-in, non-null, uniquely ordered keyset pagination.

    interface CompositeCursorOptions<
        S extends ObjectSchemaBuilder<any, any, any, any, any, any, any>,
    > {
        cursor?: string | null;
        limit: number;
        orderBy: readonly { column: ColumnRef<S>; direction: "desc" | "asc" }[];
    }

    Type Parameters

    • S extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
    Index
    cursor? limit orderBy
    cursor?: string | null

    Opaque nextCursor from a compatible page; null/undefined starts a new stream.

    limit: number

    Positive safe integer page size; one extra row determines whether more exist.

    orderBy: readonly { column: ColumnRef<S>; direction: "desc" | "asc" }[]

    Complete non-null sort, including a declared primary/unique key; replaces prior ordering.

    Settings
    Member Visibility

    On This Page
    Properties