Class WorkspaceTransaction

Index

Constructors

Methods

begin commit rollback

Constructors

`Protected`constructor

new WorkspaceTransaction(source: Workspace): WorkspaceTransaction
Parameters
- source: Workspace
Returns WorkspaceTransaction
- Defined in src/readers/workspace.transaction.ts:21

Methods

`Static`begin

begin(source: Workspace): WorkspaceTransaction
Begin a mutation transaction on a Workspace.
Parameters
- source: Workspace
  the Workspace to mutate.
Returns WorkspaceTransaction
a WorkspaceTransaction instance with commit() and rollback() methods.

Throws
an EngineError if any error was encountered.
- Defined in src/readers/workspace.transaction.ts:17

commit

commit(): void
Keep changes to the target Workspace. Calling this is currently not required.

Returns void
- Defined in src/readers/workspace.transaction.ts:30

rollback

rollback(): void
Rollback the target Workspace to before any changes were made.

Returns void
Throws
an EngineError if any error was encountered.
- Defined in src/readers/workspace.transaction.ts:38