- 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
createCollection
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & NonSingleResult;Defined in: packages/db/src/collection/index.ts:241
Type Parameters#
T#
T extends StandardSchemaV1<unknown, unknown>
TKey#
TKey extends string | number
TUtils#
TUtils extends UtilsRecord
Parameters#
options#
Omit<CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils>, "utils"> & object & NonSingleResult
Returns#
Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & NonSingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, Exclude<TUtils, undefined>, T, InferSchemaInput<T>> & NonSingleResult;Defined in: packages/db/src/collection/index.ts:258
Type Parameters#
T#
T extends StandardSchemaV1<unknown, unknown>
TKey#
TKey extends string | number
TUtils#
TUtils extends UtilsRecord
Parameters#
options#
CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils> & object & NonSingleResult
Returns#
Collection<InferSchemaOutput<T>, TKey, Exclude<TUtils, undefined>, T, InferSchemaInput<T>> & NonSingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult;Defined in: packages/db/src/collection/index.ts:276
Type Parameters#
T#
T extends StandardSchemaV1<unknown, unknown>
TKey#
TKey extends string | number
TUtils#
TUtils extends UtilsRecord
Parameters#
options#
Omit<CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils>, "utils"> & object & SingleResult
Returns#
Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult;Defined in: packages/db/src/collection/index.ts:292
Type Parameters#
T#
T extends StandardSchemaV1<unknown, unknown>
TKey#
TKey extends string | number
TUtils#
TUtils extends UtilsRecord
Parameters#
options#
CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils> & object & SingleResult
Returns#
Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & NonSingleResult;Defined in: packages/db/src/collection/index.ts:305
Type Parameters#
T#
T extends object
TKey#
TKey extends string | number
TUtils#
TUtils extends UtilsRecord
Parameters#
options#
Omit<CollectionConfig<T, TKey, never, TUtils>, "utils"> & object & NonSingleResult
Returns#
Collection<T, TKey, TUtils, never, T> & NonSingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & NonSingleResult;Defined in: packages/db/src/collection/index.ts:318
Type Parameters#
T#
T extends object
TKey#
TKey extends string | number = string | number
TUtils#
TUtils extends UtilsRecord = UtilsRecord
Parameters#
options#
CollectionConfig<T, TKey, never, TUtils> & object & NonSingleResult
Returns#
Collection<T, TKey, TUtils, never, T> & NonSingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & SingleResult;Defined in: packages/db/src/collection/index.ts:330
Type Parameters#
T#
T extends object
TKey#
TKey extends string | number = string | number
TUtils#
TUtils extends UtilsRecord = UtilsRecord
Parameters#
options#
Omit<CollectionConfig<T, TKey, never, TUtils>, "utils"> & object & SingleResult
Returns#
Collection<T, TKey, TUtils, never, T> & SingleResult
Call Signature#
function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & SingleResult;Defined in: packages/db/src/collection/index.ts:343
Type Parameters#
T#
T extends object
TKey#
TKey extends string | number = string | number
TUtils#
TUtils extends UtilsRecord = UtilsRecord
Parameters#
options#
CollectionConfig<T, TKey, never, TUtils> & object & SingleResult
Returns#
Collection<T, TKey, TUtils, never, T> & SingleResult