Interface ISharedText

The ISharedText interface defines models that can be bound to a text editor like CodeMirror.

Hierarchy

Implemented by

Properties

The changed signal.

disposed: ISignal<ISharedText, void>

A signal emitted when the object is disposed.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

source: string

Text

Methods

  • 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

  • Get text.

    Returns

    Text.

    Returns string

  • Set text.

    Parameters

    • value: string

      New text.

    Returns 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

  • Replace content from start to end with value.

    Parameters

    • start: number
    • end: number
    • Optional value: string

    Returns void

Generated using TypeDoc