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

TransactionScope.md

202 lines3.5 KB

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