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

TransactionScope.md

178 lines3.1 KB

Class: TransactionScope

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

Constructors

Constructor

new TransactionScope(): TransactionScope;

Returns

TransactionScope

Methods

clear()

clear(): void;

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

Returns

void


createTransaction()

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

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

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

config

TransactionConfig<T>

Returns

Transaction<T>


getActiveTransaction()

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

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

Returns

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


getActiveTransactionForCollection()

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

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

Returns

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


registerTransaction()

registerTransaction(transaction): void;

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

Parameters

transaction

Transaction<any>

Returns

void


removeTransaction()

removeTransaction(transaction): void;

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

Parameters

transaction

Transaction<any>

Returns

void


rollbackConflictingTransactions()

rollbackConflictingTransactions(transaction, mutationIds): void;

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

Parameters

transaction

Transaction<any>

mutationIds

Set<string>

Returns

void


unregisterTransaction()

unregisterTransaction(transaction): void;

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

Parameters

transaction

Transaction<any>

Returns

void