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/functions/withCollectionSyncConfigFactory.md
withCollectionSyncConfigFactory
ts
function withCollectionSyncConfigFactory<TSync>(sync, factory): CollectionSyncConfigWithFactory<TSync>;Defined in: packages/db/src/collection/index.ts:81
Internal
The factory must defer startSyncIfIdle until construction ends.
Type Parameters#
TSync#
TSync extends object
Parameters#
sync#
TSync
factory#
(source, utilities, startSyncIfIdle) => TSync
Returns#
CollectionSyncConfigWithFactory<TSync>