@open-editor/client/dist/index.d.ts

internal utils shared across @open-editor packages

/**
 * 调试器全局配置项
 */
interface Options {
    /**
     * 源码根目录路径
     */
    rootDir: string;
    /**
     * 是否在浏览器中显示调试开关
     */
    displayToggle?: boolean;
    /**
     * 启用调试器时是否禁用 CSS 悬停效果
     */
    disableHoverCSS?: boolean;
    /**
     * 需要忽略的组件路径匹配规则
     */
    ignoreComponents?: string | string[];
    /**
     * 是否在打开编辑器或组件树后退出检查模式
     */
    once?: boolean;
    /**
     * 是否启用跨 iframe 调试
     */
    crossIframe?: boolean;
    /**
     * 调试服务器端口号
     */
    port?: string;
}

/**
 * 初始化编辑器客户端
 *
 * @param opts - 编辑器配置对象，包含各子系统所需参数
 *
 * 功能说明：执行客户端环境检测、配置注入、模块初始化等启动流程
 *
 * 执行策略：
 *   1. 采用单例模式避免重复初始化
 *   2. 在 DOM 就绪后启动子系统
 *   3. 严格的环境检测机制
 */
declare function setupClient(opts: Options): void;

export { Options, setupClient };