PaginationOptions

PaginationOptions = ConvexPaginationOptions & object

Defined in: packages/core/src/api/types.ts:665

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

optional totalDocs?: boolean

Whether to include total document count in the response.

Only runs on the first page (when cursor is null) to avoid wasteful re-counting. Counts all documents matching the current filters/search query.

Returns null if the count exceeds Convex transaction limits (>32k documents).

false