Interface Transaction

A transaction collects ops applied step by step (e.g. a drag, or an agent iterating in a sandbox) and commits them as ONE history entry.

interface Transaction {
    doc: StudioDocument;
    ops: readonly StudioOp[];
    apply(ops: readonly StudioOp[]): void;
    commit(info?: CommitInfo): StudioState;
    rollback(): StudioState;
}

Index

Properties

Methods

apply commit rollback

Properties

`Readonly`doc

doc: StudioDocument

The document with every op applied so far.

`Readonly`ops

ops: readonly StudioOp[]

Methods

apply

apply(ops: readonly StudioOp[]): void
Apply more ops to the preview; throws OpApplyError and keeps the previous preview.
Parameters
- ops: readonly StudioOp[]
Returns void

commit

commit(info?: CommitInfo): StudioState
One history entry for everything applied.
Parameters
- Optionalinfo: CommitInfo
Returns StudioState

rollback

rollback(): StudioState

Drop everything; returns the state the transaction started from.

Returns StudioState