Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISharedBase

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

Hierarchy

Index

Properties

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Methods

canRedo

  • canRedo(): boolean

canUndo

  • canUndo(): boolean

clearUndoHistory

  • clearUndoHistory(): void

dispose

  • dispose(): void
  • 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(): void

transact

  • transact(f: () => void): void
  • Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.

    Parameters

    • f: () => void
        • (): void
        • Returns void

    Returns void

undo

  • undo(): void

Generated using TypeDoc