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/rxdb-db-collection/functions/rxdbCollectionOptions.md
API Reference
rxdbCollectionOptions
Call Signature#
ts
function rxdbCollectionOptions<T>(config): CollectionConfig<InferSchemaOutput<T>, string, T, UtilsRecord> & object;Defined in: rxdb.ts:90
Creates RxDB collection options for use with a standard Collection
Type Parameters#
T#
T extends StandardSchemaV1<unknown, unknown>
Parameters#
config#
RxDBCollectionConfig<InferSchemaOutput<T>, T>
Configuration options for the RxDB collection
Returns#
CollectionConfig<InferSchemaOutput<T>, string, T, UtilsRecord> & object
Collection options with utilities
Call Signature#
ts
function rxdbCollectionOptions<T>(config): CollectionConfig<T, string, never, UtilsRecord> & object;Defined in: rxdb.ts:97
Creates RxDB collection options for use with a standard Collection
Type Parameters#
T#
T extends object
Parameters#
config#
Omit<BaseCollectionConfig<T, string, never, UtilsRecord, any>, "getKey" | "onInsert" | "onUpdate" | "onDelete"> & object & object
Configuration options for the RxDB collection
Returns#
CollectionConfig<T, string, never, UtilsRecord> & object
Collection options with utilities