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

TransactionConfig.md

56 lines1.0 KB

1---
2id: TransactionConfig
3title: TransactionConfig
4---
5​
6Defined in: [packages/db/src/types.ts:189](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L189)
7​
8## Type Parameters
9​
10### T
11​
12`T` *extends* `object` = `Record`\<`string`, `unknown`\>
13​
14## Properties
15​
16### autoCommit?
17​
18```ts
19optional autoCommit: boolean;
20```
21​
22Defined in: [packages/db/src/types.ts:193](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L193)
23​
24***
25​
26### id?
27​
28```ts
29optional id: string;
30```
31​
32Defined in: [packages/db/src/types.ts:191](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L191)
33​
34Unique identifier for the transaction
35​
36***
37​
38### metadata?
39​
40```ts
41optional metadata: Record<string, unknown>;
42```
43​
44Defined in: [packages/db/src/types.ts:196](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L196)
45​
46Custom metadata to associate with the transaction
47​
48***
49​
50### mutationFn
51​
52```ts
53mutationFn: MutationFn<T>;
54```
55​
56Defined in: [packages/db/src/types.ts:194](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L194)