Interface ISharedBase

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

Hierarchy

IObservableDisposable
- ISharedBase
  - ISharedDocument
  - ISharedText

Index

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

canRedo(): boolean
Whether the object can undo changes.

Returns boolean
- Defined in src/api.ts:66

canUndo

canUndo(): boolean
Whether the object can redo changes.

Returns boolean
- Defined in src/api.ts:61

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
- Defined in src/api.ts:71

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
Inherited from IObservableDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

redo

redo(): void
Redo an operation.

Returns void
- Defined in src/api.ts:56

transact

transact(f: (() => void), undoable?: boolean): 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)
  
  Transaction to execute
  - - (): void
    - Returns void
- Optional undoable: boolean
  
  Whether to track the change in the action history or not (default true)
Returns void
- Defined in src/api.ts:80

undo

undo(): void
Undo an operation.

Returns void
- Defined in src/api.ts:51

Generated using TypeDoc