Interface ISharedBase

ISharedBase defines common operations that can be performed on any shared object.

Hierarchy

Properties

disposed isDisposed

Methods

canRedo canUndo clearUndoHistory dispose redo transact undo

Properties

Readonly disposed

disposed: ISignal<ISharedBase, void>

A signal emitted when the object is disposed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Methods

canRedo

  • Whether the object can undo changes.

    Returns boolean

canUndo

  • Whether the object can redo changes.

    Returns boolean

clearUndoHistory

  • Clear the change stack.

    Returns void

dispose

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

redo

  • Redo an operation.

    Returns

    Whether a change was made.

    Returns boolean

transact

  • Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.

    Parameters

    • f: (() => void)

      Transaction to execute

        • (): void

        • Returns void

    • Optional undoable: boolean

      Whether to track the change in the action history or not (default true)

    • Optional origin: any

    Returns void

undo

  • Undo an operation.

    Returns

    Whether a change was made.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc