@textbus/collaborate/bundles/base/sync-connector.d.ts

Textbus is a rich text editor and framework that is highly customizable and extensible to achieve rich wysiwyg effects.

import { Observable, Subject } from '@tanbo/stream';
/**
 * 协作通信通用接口
 */
export declare abstract class SyncConnector {
    /**
     * 当文档加载完成时触发的观察者
     */
    onLoad: Observable<void>;
    /**
     * 当文档 awareness 状态变更时触发的观察者
     */
    onStateChange: Observable<any[]>;
    protected loadEvent: Subject<void>;
    protected stateChangeEvent: Subject<any[]>;
    protected constructor();
    /**
     * 设置 awareness 状态
     * @param key 状态的 key
     * @param data 状态值
     */
    abstract setLocalStateField(key: string, data: Record<string, any>): void;
    /**
     * 当文档销毁时调用
     */
    abstract onDestroy(): void;
}