DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/convex-db-collection/type-aliases/ConvexPaginatedCollectionConfig.md
ConvexPaginatedCollectionConfig
ts
type ConvexPaginatedCollectionConfig<TQuery, TItem, TKey, TSchema> = Omit<BaseCollectionConfig<TItem, TKey, TSchema, ConvexCollectionUtils, unknown>, "syncMode" | "utils" | "schema"> & object & [TSchema] extends [never] ? object : object & FunctionReturnType<TQuery> extends PaginationResult<object> ? unknown : never & FunctionArgs<TQuery> extends object ? unknown : never &
| {
select: (rows) => ReadonlyArray<TItem>;
}
| PaginatedRow<TQuery> extends TItem ? object : never;Defined in: paginated-options.ts:20
Type Declaration#
client#
ts
client: ConvexCollectionClient;maxRows?#
ts
optional maxRows: number;Maximum accepted rows in the complete eager mirror. Defaults to 10,000.
onError()?#
ts
optional onError: (error) => void;Parameters#
error#
unknown
Returns#
void
pageSize?#
ts
optional pageSize: number;query#
ts
query: TQuery;queryArgs#
ts
queryArgs: Omit<FunctionArgs<TQuery>, "paginationOpts">;Type Parameters#
TQuery#
TQuery extends FunctionReference<"query">
TItem#
TItem extends object = PaginatedRow<TQuery>
TKey#
TKey extends string | number = string | number
TSchema#
TSchema extends StandardSchemaV1<TItem, TItem> = never