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

TransactionScope.md

176 lines3.0 KB

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