用途:@tanstack/devtools-event-client 是一个类型化的事件发布/订阅客户端,用于将应用或库代码连接到 TanStack Devtools 面板,框架无关,可用于 React、Vue、Solid、Preact 和原生 JS。
安装:npm i @tanstack/devtools-event-client
入口:根导出在开发环境为真实客户端,在生产构建中被 tree-shaking 移除为 no-op;/production 子路径始终为真实客户端,适合希望生产环境也保留 devtools 事件的库。
构造选项:pluginId(字符串,必填,需全局唯一);debug(布尔,默认 false,开启带 [tanstack-devtools:{pluginId}-plugin] 前缀的详细日志);enabled(布尔,默认 true,为 false 时 emit() 为空操作,on() 返回空清理函数);reconnectEveryMs(数字,默认 300,连接重试间隔,最多 5 次)。
核心用法:定义事件映射类型(键仅为后缀),继承 EventClient 并在模块级导出单例;用 emit(suffix, payload) 发送事件,pluginId 会自动加前缀,例如 pluginId 为 store-inspector、后缀为 state-changed 时总线事件名为 store-inspector:state-changed;监听方法均返回清理函数:on(suffix, callback) 监听本插件特定事件,可传 { withEventTarget: true },onAll(callback) 监听所有插件事件,onAllPluginEvents(callback) 只监听本插件事件。
连接生命周期:首次 emit() 时惰性发起连接并进入重试循环,成功后按序冲刷内存中排队的事件;5 次重试失败后 failedToConnect 永久置位,后续 emit() 被静默丢弃。
常见错误:事件名不要手动加 pluginId 前缀(会双重前缀);每个插件只创建一个实例;pluginId 必须唯一;注意重试耗尽后事件丢弃,可增大 reconnectEveryMs;仅在 on() 时不会触发连接;负载需可 JSON 序列化,避免函数、DOM 节点、类实例、Map/Set 和循环引用;根导出在非开发环境(含 NODE_ENV 未设置)为 no-op。
限制:重试次数固定为 5,无法增加;官方资料未提供价格或平台可用性等信息。