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

TrailBaseCollectionConfig.md

76 lines1.7 KB

1---
2id: TrailBaseCollectionConfig
3title: TrailBaseCollectionConfig
4---
5​
6# Interface: TrailBaseCollectionConfig\<TItem, TRecord, TKey\>
7​
8Defined in: [packages/trailbase-db-collection/src/trailbase.ts:92](https://github.com/TanStack/db/blob/main/packages/trailbase-db-collection/src/trailbase.ts#L92)
9​
10Configuration interface for Trailbase Collection
11​
12## Extends
13​
14- `Omit`\<`BaseCollectionConfig`\<`TItem`, `TKey`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"syncMode"`\>
15​
16## Type Parameters
17​
18### TItem
19​
20`TItem` *extends* `ShapeOf`\<`TRecord`\>
21​
22### TRecord
23​
24`TRecord` *extends* `ShapeOf`\<`TItem`\> = `TItem`
25​
26### TKey
27​
28`TKey` *extends* `string` \| `number` = `string` \| `number`
29​
30## Properties
31​
32### parse
33​
34```ts
35parse: Conversions<TRecord, TItem>;
36```
37​
38Defined in: [packages/trailbase-db-collection/src/trailbase.ts:111](https://github.com/TanStack/db/blob/main/packages/trailbase-db-collection/src/trailbase.ts#L111)
39​
40***
41​
42### recordApi
43​
44```ts
45recordApi: RecordApi<TRecord>;
46```
47​
48Defined in: [packages/trailbase-db-collection/src/trailbase.ts:103](https://github.com/TanStack/db/blob/main/packages/trailbase-db-collection/src/trailbase.ts#L103)
49​
50Record API name
51​
52***
53​
54### serialize
55​
56```ts
57serialize: Conversions<TItem, TRecord>;
58```
59​
60Defined in: [packages/trailbase-db-collection/src/trailbase.ts:112](https://github.com/TanStack/db/blob/main/packages/trailbase-db-collection/src/trailbase.ts#L112)
61​
62***
63​
64### syncMode?
65​
66```ts
67optional syncMode: SyncMode;
68```
69​
70Defined in: [packages/trailbase-db-collection/src/trailbase.ts:109](https://github.com/TanStack/db/blob/main/packages/trailbase-db-collection/src/trailbase.ts#L109)
71​
72The mode of sync to use for the collection.
73​
74#### Default
75​
76`eager`