Open History to see the last commit
1---
2id: CreateOptimisticActionsOptions
3title: CreateOptimisticActionsOptions
4---
5
6# Interface: CreateOptimisticActionsOptions\<TVars, T\>
7
8Defined in: [packages/db/src/types.ts:181](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L181)
9
10Options for the createOptimisticAction helper
11
12## Extends
13
14- `Omit`\<[`TransactionConfig`](TransactionConfig.md)\<`T`\>, `"mutationFn"`\>
15
16## Type Parameters
17
18### TVars
19
20`TVars` = `unknown`
21
22### T
23
24`T` *extends* `object` = `Record`\<`string`, `unknown`\>
25
26## Properties
27
28### autoCommit?
29
30```ts
31optional autoCommit: boolean;
32```
33
34Defined in: [packages/db/src/types.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L172)
35
36#### Inherited from
37
38[`TransactionConfig`](TransactionConfig.md).[`autoCommit`](TransactionConfig.md#autocommit)
39
40***
41
42### id?
43
44```ts
45optional id: string;
46```
47
48Defined in: [packages/db/src/types.ts:170](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L170)
49
50Unique identifier for the transaction
51
52#### Inherited from
53
54[`TransactionConfig`](TransactionConfig.md).[`id`](TransactionConfig.md#id)
55
56***
57
58### metadata?
59
60```ts
61optional metadata: Record<string, unknown>;
62```
63
64Defined in: [packages/db/src/types.ts:175](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L175)
65
66Custom metadata to associate with the transaction
67
68#### Inherited from
69
70[`TransactionConfig`](TransactionConfig.md).[`metadata`](TransactionConfig.md#metadata)
71
72***
73
74### mutationFn()
75
76```ts
77mutationFn: (vars, params) => Promise<any>;
78```
79
80Defined in: [packages/db/src/types.ts:188](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L188)
81
82Function to execute the mutation on the server
83
84#### Parameters
85
86##### vars
87
88`TVars`
89
90##### params
91
92[`MutationFnParams`](../type-aliases/MutationFnParams.md)\<`T`\>
93
94#### Returns
95
96`Promise`\<`any`\>
97
98***
99
100### onMutate()
101
102```ts
103onMutate: (vars) => void;
104```
105
106Defined in: [packages/db/src/types.ts:186](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L186)
107
108Function to apply optimistic updates locally before the mutation completes
109
110#### Parameters
111
112##### vars
113
114`TVars`
115
116#### Returns
117
118`void`