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

SyncMetadataApi.md

154 lines1.5 KB

1---
2id: SyncMetadataApi
3title: SyncMetadataApi
4---
5​
6# Interface: SyncMetadataApi\<TKey\>
7​
8Defined in: [packages/db/src/types.ts:362](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L362)
9​
10## Type Parameters
11​
12### TKey
13​
14`TKey` *extends* `string` \| `number` = `string` \| `number`
15​
16## Properties
17​
18### collection
19​
20```ts
21collection: object;
22```
23​
24Defined in: [packages/db/src/types.ts:370](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L370)
25​
26#### delete()
27​
28```ts
29delete: (key) => void;
30```
31​
32##### Parameters
33​
34###### key
35​
36`string`
37​
38##### Returns
39​
40`void`
41​
42#### get()
43​
44```ts
45get: (key) => unknown;
46```
47​
48##### Parameters
49​
50###### key
51​
52`string`
53​
54##### Returns
55​
56`unknown`
57​
58#### list()
59​
60```ts
61list: (prefix?) => readonly object[];
62```
63​
64##### Parameters
65​
66###### prefix?
67​
68`string`
69​
70##### Returns
71​
72readonly `object`[]
73​
74#### set()
75​
76```ts
77set: (key, value) => void;
78```
79​
80##### Parameters
81​
82###### key
83​
84`string`
85​
86###### value
87​
88`unknown`
89​
90##### Returns
91​
92`void`
93​
94***
95​
96### row
97​
98```ts
99row: object;
100```
101​
102Defined in: [packages/db/src/types.ts:365](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L365)
103​
104#### delete()
105​
106```ts
107delete: (key) => void;
108```
109​
110##### Parameters
111​
112###### key
113​
114`TKey`
115​
116##### Returns
117​
118`void`
119​
120#### get()
121​
122```ts
123get: (key) => unknown;
124```
125​
126##### Parameters
127​
128###### key
129​
130`TKey`
131​
132##### Returns
133​
134`unknown`
135​
136#### set()
137​
138```ts
139set: (key, metadata) => void;
140```
141​
142##### Parameters
143​
144###### key
145​
146`TKey`
147​
148###### metadata
149​
150`unknown`
151​
152##### Returns
153​
154`void`