PaginationOptions
PaginationOptions =
ConvexPaginationOptions&object
Defined in: packages/core/src/db/types.ts:216
Pagination options for Convex queries.
Re-exported from convex/server for convenience. This is the exact type
that Convex’s .paginate(opts) API expects.
Type Declaration
Section titled “Type Declaration”totalDocs?
Section titled “totalDocs?”
optionaltotalDocs?:boolean
Whether to include a total document count in the response.
Only runs on the first page (when cursor is null) to avoid wasteful
re-counting. Counts at most admin.view.state.countLimit + 1 matching
documents (default 10000; search clamps to 1023, Convex’s search-result ceiling) — see PaginationResult.totalDocsCapped
(Design Decision 35).
Default
Section titled “Default”false