Defined in: node_modules/convex/dist/esm-types/server/pagination.d.ts:25
The result of paginating using OrderedQuery.paginate.
Type Parameters#
Properties#
| Property | Type | Description | Defined in |
|---|
continueCursor | string | A Cursor to continue loading more results. | node_modules/convex/dist/esm-types/server/pagination.d.ts:37 |
isDone | boolean | Have we reached the end of the results? | node_modules/convex/dist/esm-types/server/pagination.d.ts:33 |
page | T[] | The page of results. | node_modules/convex/dist/esm-types/server/pagination.d.ts:29 |
pageStatus? | "SplitRecommended" | "SplitRequired" | null | When a query reads too much data, it may return 'SplitRecommended' to indicate that the page should be split into two with splitCursor. When a query reads so much data that page might be incomplete, its status becomes 'SplitRequired'. | node_modules/convex/dist/esm-types/server/pagination.d.ts:50 |
splitCursor? | string | null | A Cursor to split the page into two, so the page from (cursor, continueCursor] can be replaced by two pages (cursor, splitCursor] and (splitCursor, continueCursor]. | node_modules/convex/dist/esm-types/server/pagination.d.ts:43 |