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/interfaces/ConvexCollectionUtils.md
ConvexCollectionUtils
Defined in: options.ts:15
Extends#
- UtilsRecord
Indexable#
ts
[key: string]: anyProperties#
awaitSync()#
ts
awaitSync: () => Promise<void>;Defined in: options.ts:19
Refresh the source cache and wait for sync acceptance, safe inside mutation handlers.
Returns#
Promise<void>
getSyncError()#
ts
getSyncError: () => unknown;Defined in: options.ts:17
Last subscription or conversion error, cleared by the next valid result.
Returns#
unknown