TanStack

TransactionScope

Class: TransactionScope

Defined in: packages/db/src/transactions.ts:21

Constructors

Constructor

ts
new TransactionScope(): TransactionScope;

Returns

TransactionScope

Methods

clear()

ts
clear(): void;

Defined in: packages/db/src/transactions.ts:119

Returns

void


createTransaction()

ts
createTransaction<T>(config): Transaction<T>;

Defined in: packages/db/src/transactions.ts:26

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

config

TransactionConfig<T>

Returns

Transaction<T>


getActiveTransaction()

ts
getActiveTransaction(): 
  | Transaction<Record<string, unknown>>
  | undefined;

Defined in: packages/db/src/transactions.ts:34

Returns

| Transaction<Record<string, unknown>> | undefined


getActiveTransactionForCollection()

ts
getActiveTransactionForCollection(): 
  | Transaction<Record<string, unknown>>
  | undefined;

Defined in: packages/db/src/transactions.ts:38

Returns

| Transaction<Record<string, unknown>> | undefined


registerTransaction()

ts
registerTransaction(transaction): void;

Defined in: packages/db/src/transactions.ts:77

Parameters

transaction

Transaction<any>

Returns

void


removeTransaction()

ts
removeTransaction(transaction): void;

Defined in: packages/db/src/transactions.ts:93

Parameters

transaction

Transaction<any>

Returns

void


rollbackConflictingTransactions()

ts
rollbackConflictingTransactions(transaction, mutationIds): void;

Defined in: packages/db/src/transactions.ts:102

Parameters

transaction

Transaction<any>

mutationIds

Set<string>

Returns

void


unregisterTransaction()

ts
unregisterTransaction(transaction): void;

Defined in: packages/db/src/transactions.ts:83

Parameters

transaction

Transaction<any>

Returns

void