electricCollectionOptions

Function: electricCollectionOptions()

Call Signature

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

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

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

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

Collection options with utilities

Call Signature

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

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

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

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

Collection options with utilities