Interface IYText

Abstract interface to define Shared Models that can be bound to a text editor using any existing Yjs-based editor binding.


Implemented by


awareness: null | Awareness

Shareable awareness

The changed signal.

disposed: ISignal<IYText, void>

A signal emitted when the object is disposed.

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

source: string


undoManager: null | UndoManager

Undo manager

ysource: YText

Shareable text


  • Dispose of the resources held by the object.


    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

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


    • 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.


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

    Returns void

Generated using TypeDoc