Skip to content

PaginationResult

PaginationResult<T> = ConvexPaginationResult<T> & object

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

Pagination result from Convex query.

Re-exported from convex/server. Returned by queries using .paginate(opts).

Includes:

  • page: T[] — Current page of results
  • isDone: boolean — Whether this is the last page
  • continueCursor: string — Cursor to fetch next page
  • splitCursor?: string | null — Cursor to split large pages (optional)
  • pageStatus?: "SplitRecommended" | "SplitRequired" | null — Indicates when to split (optional)

optional totalDocs?: number | null

T

https://docs.convex.dev/database/pagination