Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

TrailBaseCollectionConfig.md

74 lines1.6 KB

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

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>;

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


recordApi

recordApi: RecordApi<TRecord>;

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

Record API name


serialize

serialize: Conversions<TItem, TRecord>;

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


syncMode?

optional syncMode: SyncMode;

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

The mode of sync to use for the collection.

Default

eager