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/validateSyncPersistenceCapability.md
validateSyncPersistenceCapability
ts
function validateSyncPersistenceCapability<TKey>(value):
| SyncPersistenceCapabilityV1<TKey>
| null;Defined in: packages/db/src/sync-persistence.ts:38
Internal
Validates the cross-package structural persistence protocol before a sync adapter uses it. Null explicitly means that the collection has no persistence capability; undefined means a wrapper dropped the required field. Any advertised capability must be complete.
This is adapter infrastructure, not an application API.
Type Parameters#
TKey#
TKey extends string | number = string | number
Parameters#
value#
unknown
Returns#
| SyncPersistenceCapabilityV1<TKey> | null