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

PendingMutation.md

157 lines3.0 KB

1---
2id: PendingMutation
3title: PendingMutation
4---
5​
6# Interface: PendingMutation\<T, TOperation, TCollection\>
7​
8Defined in: [packages/db/src/types.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L91)
9​
10Represents a pending mutation within a transaction
11Contains information about the original and modified data, as well as metadata
12​
13## Type Parameters
14​
15### T
16​
17`T` *extends* `object` = `Record`\<`string`, `unknown`\>
18​
19### TOperation
20​
21`TOperation` *extends* [`OperationType`](../type-aliases/OperationType.md) = [`OperationType`](../type-aliases/OperationType.md)
22​
23### TCollection
24​
25`TCollection` *extends* [`Collection`](Collection.md)\<`T`, `any`, `any`, `any`, `any`\> = [`Collection`](Collection.md)\<`T`, `any`, `any`, `any`, `any`\>
26​
27## Properties
28​
29### changes
30​
31```ts
32changes: ResolveTransactionChanges<T, TOperation>;
33```
34​
35Defined in: [packages/db/src/types.ts:108](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L108)
36​
37***
38​
39### collection
40​
41```ts
42collection: TCollection;
43```
44​
45Defined in: [packages/db/src/types.ts:119](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L119)
46​
47***
48​
49### createdAt
50​
51```ts
52createdAt: Date;
53```
54​
55Defined in: [packages/db/src/types.ts:117](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L117)
56​
57***
58​
59### globalKey
60​
61```ts
62globalKey: string;
63```
64​
65Defined in: [packages/db/src/types.ts:109](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L109)
66​
67***
68​
69### key
70​
71```ts
72key: any;
73```
74​
75Defined in: [packages/db/src/types.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L111)
76​
77***
78​
79### metadata
80​
81```ts
82metadata: unknown;
83```
84​
85Defined in: [packages/db/src/types.ts:113](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L113)
86​
87***
88​
89### modified
90​
91```ts
92modified: T;
93```
94​
95Defined in: [packages/db/src/types.ts:106](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L106)
96​
97***
98​
99### mutationId
100​
101```ts
102mutationId: string;
103```
104​
105Defined in: [packages/db/src/types.ts:102](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L102)
106​
107***
108​
109### optimistic
110​
111```ts
112optimistic: boolean;
113```
114​
115Defined in: [packages/db/src/types.ts:116](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L116)
116​
117Whether this mutation should be applied optimistically (defaults to true)
118​
119***
120​
121### original
122​
123```ts
124original: TOperation extends "insert" ? object : T;
125```
126​
127Defined in: [packages/db/src/types.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L104)
128​
129***
130​
131### syncMetadata
132​
133```ts
134syncMetadata: Record<string, unknown>;
135```
136​
137Defined in: [packages/db/src/types.ts:114](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L114)
138​
139***
140​
141### type
142​
143```ts
144type: TOperation;
145```
146​
147Defined in: [packages/db/src/types.ts:112](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L112)
148​
149***
150​
151### updatedAt
152​
153```ts
154updatedAt: Date;
155```
156​
157Defined in: [packages/db/src/types.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L118)