electricCollectionOptions

Function: electricCollectionOptions()

Call Signature

ts
function electricCollectionOptions<T>(config): Omit<CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord>, "utils"> & object;
function electricCollectionOptions<T>(config): Omit<CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord>, "utils"> & object;

Defined in: packages/electric-db-collection/src/electric.ts:427

Creates Electric collection options for use with a standard Collection

Type Parameters

T

T extends StandardSchemaV1<unknown, unknown>

The explicit type of items in the collection (highest priority)

Parameters

config

ElectricCollectionConfig<InferSchemaOutput<T>, T> & object

Configuration options for the Electric collection

Returns

Omit<CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord>, "utils"> & object

Collection options with utilities

Call Signature

ts
function electricCollectionOptions<T>(config): Omit<CollectionConfig<T, string | number, never, UtilsRecord>, "utils"> & object;
function electricCollectionOptions<T>(config): Omit<CollectionConfig<T, string | number, never, UtilsRecord>, "utils"> & object;

Defined in: packages/electric-db-collection/src/electric.ts:438

Creates Electric collection options for use with a standard Collection

Type Parameters

T

T extends Row<unknown>

The explicit type of items in the collection (highest priority)

Parameters

config

ElectricCollectionConfig<T, never> & object

Configuration options for the Electric collection

Returns

Omit<CollectionConfig<T, string | number, never, UtilsRecord>, "utils"> & object

Collection options with utilities

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.