Interface Participant

Components with support for transactionality implement this interface.

interface Participant {
    postCommit?: (() => MaybePromise);
    preCommit?: (() => MaybePromise<boolean>);
    role?: {};
    commit1(): MaybePromise;
    commit2(): MaybePromise;
    rollback(): MaybePromise;
    toString(): string;
}

Properties

postCommit? preCommit? role?

Methods

commit1 commit2 rollback toString

Properties

OptionalpostCommit

postCommit?: (() => MaybePromise)

Post-commit logic.

OptionalpreCommit

preCommit?: (() => MaybePromise<boolean>)

Pre-commit logic.

Pre-commit logic returns a boolean indicating whether it performed an action that affects state. The transaction will cycle through participants continuously until all participants return false.

Thus preCommit implementations must be stateful and expect to be invoked more than once for a single transaction.

Optionalrole

role?: {}

The "role" of a participant is an optional key you may use to retrieve a participant from the transaction.

Methods

commit1

  • commit1(): MaybePromise

  • Commit phase one.

    Returns MaybePromise

commit2

  • commit2(): MaybePromise

  • Commit phase two.

    Returns MaybePromise

rollback

  • rollback(): MaybePromise

  • Drop isolated writes and revert to original canonical source.

    Returns MaybePromise

toString

  • toString(): string

  • Description used in error messages.

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods