Defined in: node_modules/convex/dist/esm-types/server/pagination.d.ts:60
The options passed to OrderedQuery.paginate.
To use this type in argument validation,
use the paginationOptsValidator.
Properties#
| Property | Type | Description | Defined in |
|---|
cursor | string | null | A Cursor representing the start of this page or null to start at the beginning of the query results. | node_modules/convex/dist/esm-types/server/pagination.d.ts:75 |
endCursor? | string | null | A Cursor representing the end of this page or `null | undefinedto usenumItemsinstead. This explicitly sets the range of documents the query will return, fromcursortoendCursor. It's used by reactive pagination clients to ensure there are no gaps between pages when data changes, and to split pages when pageStatusindicates a split is recommended or required. When splitting a page, use the returnedsplitCursorasendCursorfor the first half and ascursor` for the second half. |
maximumBytesRead? | number | The maximum number of bytes to read from the database during pagination. This limits bytes entering the query pipeline before filters are applied. Use this to control bandwidth usage when documents are large. If the limit is reached, the query may return an incomplete page and require a page split. Currently this is not enforced for search queries. | node_modules/convex/dist/esm-types/server/pagination.d.ts:109 |
maximumRowsRead? | number | The maximum number of rows to read from the database during pagination. This limits rows entering the query pipeline before filters are applied. Use this when filtering for rare items, where low numItems won't bound execution time because the query scans many rows to find matches. Currently this is not enforced for search queries. | node_modules/convex/dist/esm-types/server/pagination.d.ts:98 |
numItems | number | Number of items to load in this page of results. Note: This is only an initial value! If you are running this paginated query in a reactive query function, you may receive more or less items than this if items were added to or removed from the query range. | node_modules/convex/dist/esm-types/server/pagination.d.ts:70 |