Interface: TrailBaseCollectionConfig<TItem, TRecord, TKey>#

Defined in: packages/trailbase-db-collection/src/trailbase.ts:92

Configuration interface for Trailbase Collection

Extends#

• Omit<BaseCollectionConfig<TItem, TKey>, "onInsert" | "onUpdate" | "onDelete" | "syncMode">

Type Parameters#

TItem#

TItem extends ShapeOf<TRecord>

TRecord#

TRecord extends ShapeOf<TItem> = TItem

TKey#

TKey extends string | number = string | number

Properties#

parse#

parse: Conversions<TRecord, TItem>;

parse: Conversions<TRecord, TItem>;

Defined in: packages/trailbase-db-collection/src/trailbase.ts:111

recordApi#

recordApi: RecordApi<TRecord>;

recordApi: RecordApi<TRecord>;

Defined in: packages/trailbase-db-collection/src/trailbase.ts:103

Record API name

serialize#

serialize: Conversions<TItem, TRecord>;

serialize: Conversions<TItem, TRecord>;

Defined in: packages/trailbase-db-collection/src/trailbase.ts:112

syncMode?#

optional syncMode: SyncMode;

optional syncMode: SyncMode;

Defined in: packages/trailbase-db-collection/src/trailbase.ts:109

The mode of sync to use for the collection.

Default#

eager