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

OptimisticChangeMessage.md

98 lines1.9 KB

1---
2id: OptimisticChangeMessage
3title: OptimisticChangeMessage
4---
5​
6# Interface: OptimisticChangeMessage\<T\>
7​
8Defined in: [packages/db/src/types.ts:303](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L303)
9​
10## Extends
11​
12- [`ChangeMessage`](../ChangeMessage.md)\<`T`\>
13​
14## Type Parameters
15​
16### T
17​
18`T` *extends* `object` = `Record`\<`string`, `unknown`\>
19​
20## Properties
21​
22### isActive?
23​
24```ts
25optional isActive: boolean;
26```
27​
28Defined in: [packages/db/src/types.ts:307](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L307)
29​
30***
31​
32### key
33​
34```ts
35key: string | number;
36```
37​
38Defined in: [packages/db/src/types.ts:296](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L296)
39​
40#### Inherited from
41​
42[`ChangeMessage`](../ChangeMessage.md).[`key`](../ChangeMessage.md#key)
43​
44***
45​
46### metadata?
47​
48```ts
49optional metadata: Record<string, unknown>;
50```
51​
52Defined in: [packages/db/src/types.ts:300](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L300)
53​
54#### Inherited from
55​
56[`ChangeMessage`](../ChangeMessage.md).[`metadata`](../ChangeMessage.md#metadata)
57​
58***
59​
60### previousValue?
61​
62```ts
63optional previousValue: T;
64```
65​
66Defined in: [packages/db/src/types.ts:298](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L298)
67​
68#### Inherited from
69​
70[`ChangeMessage`](../ChangeMessage.md).[`previousValue`](../ChangeMessage.md#previousvalue)
71​
72***
73​
74### type
75​
76```ts
77type: OperationType;
78```
79​
80Defined in: [packages/db/src/types.ts:299](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L299)
81​
82#### Inherited from
83​
84[`ChangeMessage`](../ChangeMessage.md).[`type`](../ChangeMessage.md#type)
85​
86***
87​
88### value
89​
90```ts
91value: T;
92```
93​
94Defined in: [packages/db/src/types.ts:297](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L297)
95​
96#### Inherited from
97​
98[`ChangeMessage`](../ChangeMessage.md).[`value`](../ChangeMessage.md#value)