Interface ITransaction

Objects that implement this interface have ACID properties.

interface ITransaction {
    beginTransaction(
        options?: StoreOperationOptions,
        onClose?: CloseCallback,
    ): ITransaction;
    commit<View = any, P = any>(
        options?: StoreOperationOptions<View, P>,
    ): ITransaction;
    getDepth(): number;
    getDescription(): string;
    getId(): string;
    getParent(): ITransaction;
    getState<STATE = any>(model: any): Readonly<STATE>;
    getStates(): Map<any, any>;
    getView(): Record<string, any>;
    rollback(): ITransaction;
    updateState<STATE = any>(
        model: any,
        state:
            | Readonly<Partial<STATE>>
            | ((prev: Readonly<STATE>) => Readonly<STATE>),
    ): STATE;
}

Index

Methods

beginTransaction commit getDepth getDescription getId getParent getState getStates getView rollback updateState

Methods

beginTransaction

beginTransaction(
options?: StoreOperationOptions,
onClose?: CloseCallback,
): ITransaction
Begin a transaction with self contained, non-eventing updates.
Parameters
- Optionaloptions: StoreOperationOptions
  The description of the transaction or options.
- OptionalonClose: CloseCallback
  A callback for when the transaction is closed (due to either a commit or rollback).
Returns ITransaction
Remarks
description is useful for debugging and logging.

Transactions are treated as a stack so with fifo remove. When the final commit is applied to global only the final transaction will be maintained.

commit

commit<View = any, P = any>(
options?: StoreOperationOptions<View, P>,
): ITransaction
Commit the transaction and all children transactions to the parent transaction.
Type Parameters
- View = any
- P = any
Parameters
- Optionaloptions: StoreOperationOptions<View, P>
  A final description or options to apply on commit.
Returns ITransaction

getDepth

getDepth(): number
0-Based depth of the current transaction. If 0 then it's globally available.

Returns number

getDescription

getDescription(): string
Describes the current transaction.

Returns string

getId

getId(): string
A unique id for this transaction. This will be the same id for all sub transactions.

Returns string

getParent

getParent(): ITransaction
If root transaction will return self.

Returns ITransaction

getState

getState<STATE = any>(model: any): Readonly<STATE>
Returns the state associated to a record for the current transaction or globally if there are no open transactions.
Type Parameters
- STATE = any
Parameters
- model: any
  The ITransactional object.
Returns Readonly<STATE>

getStates

getStates(): Map<any, any>
All states in the current transaction.

Returns Map<any, any>

getView

getView(): Record<string, any>
Returns the view associated with this transaction.

Returns Record<string, any>

rollback

rollback(): ITransaction
Discard all changes and children transaction changes.

Returns ITransaction

updateState

updateState<STATE = any>(
    model: any,
    state:
        | Readonly<Partial<STATE>>
        | ((prev: Readonly<STATE>) => Readonly<STATE>),
): STATE
Update the state for a record.
Type Parameters
- STATE = any
Parameters
- model: any
- state: Readonly<Partial<STATE>> | ((prev: Readonly<STATE>) => Readonly<STATE>)
Returns STATE