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

TransactionScope.md

178 lines3.1 KB

1---
2id: TransactionScope
3title: TransactionScope
4---
5​
6# Class: TransactionScope
7​
8Defined in: [packages/db/src/transactions.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L20)
9​
10## Constructors
11​
12### Constructor
13​
14```ts
15new TransactionScope(): TransactionScope;
16```
17​
18#### Returns
19​
20`TransactionScope`
21​
22## Methods
23​
24### clear()
25​
26```ts
27clear(): void;
28```
29​
30Defined in: [packages/db/src/transactions.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L118)
31​
32#### Returns
33​
34`void`
35​
36***
37​
38### createTransaction()
39​
40```ts
41createTransaction<T>(config): Transaction<T>;
42```
43​
44Defined in: [packages/db/src/transactions.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L25)
45​
46#### Type Parameters
47​
48##### T
49​
50`T` *extends* `object` = `Record`\<`string`, `unknown`\>
51​
52#### Parameters
53​
54##### config
55​
56[`TransactionConfig`](../interfaces/TransactionConfig.md)\<`T`\>
57​
58#### Returns
59​
60[`Transaction`](../interfaces/Transaction.md)\<`T`\>
61​
62***
63​
64### getActiveTransaction()
65​
66```ts
67getActiveTransaction():
68 | Transaction<Record<string, unknown>>
69 | undefined;
70```
71​
72Defined in: [packages/db/src/transactions.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L33)
73​
74#### Returns
75​
76 \| [`Transaction`](../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\>
77 \| `undefined`
78​
79***
80​
81### getActiveTransactionForCollection()
82​
83```ts
84getActiveTransactionForCollection():
85 | Transaction<Record<string, unknown>>
86 | undefined;
87```
88​
89Defined in: [packages/db/src/transactions.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L37)
90​
91#### Returns
92​
93 \| [`Transaction`](../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\>
94 \| `undefined`
95​
96***
97​
98### registerTransaction()
99​
100```ts
101registerTransaction(transaction): void;
102```
103​
104Defined in: [packages/db/src/transactions.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L76)
105​
106#### Parameters
107​
108##### transaction
109​
110[`Transaction`](../interfaces/Transaction.md)\<`any`\>
111​
112#### Returns
113​
114`void`
115​
116***
117​
118### removeTransaction()
119​
120```ts
121removeTransaction(transaction): void;
122```
123​
124Defined in: [packages/db/src/transactions.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L92)
125​
126#### Parameters
127​
128##### transaction
129​
130[`Transaction`](../interfaces/Transaction.md)\<`any`\>
131​
132#### Returns
133​
134`void`
135​
136***
137​
138### rollbackConflictingTransactions()
139​
140```ts
141rollbackConflictingTransactions(transaction, mutationIds): void;
142```
143​
144Defined in: [packages/db/src/transactions.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L101)
145​
146#### Parameters
147​
148##### transaction
149​
150[`Transaction`](../interfaces/Transaction.md)\<`any`\>
151​
152##### mutationIds
153​
154`Set`\<`string`\>
155​
156#### Returns
157​
158`void`
159​
160***
161​
162### unregisterTransaction()
163​
164```ts
165unregisterTransaction(transaction): void;
166```
167​
168Defined in: [packages/db/src/transactions.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L82)
169​
170#### Parameters
171​
172##### transaction
173​
174[`Transaction`](../interfaces/Transaction.md)\<`any`\>
175​
176#### Returns
177​
178`void`