@jupyter/ydoc/lib/ytext.d.ts

Jupyter document structures for collaborative editing using YJS

import { Awareness } from 'y-protocols/awareness';
import * as Y from 'yjs';
import type { ISharedText } from './api.js';
/**
 * Abstract interface to define Shared Models that can be bound to a text editor using any existing
 * Yjs-based editor binding.
 */
export interface IYText extends ISharedText {
    /**
     * Shareable text
     */
    readonly ysource: Y.Text;
    /**
     * Shareable awareness
     */
    readonly awareness: Awareness | null;
    /**
     * Undo manager
     */
    readonly undoManager: Y.UndoManager | null;
}