Skip to content

Breeze 插件开发文档

面向第三方插件开发者的接口与实现文档。

文档聚焦插件接口契约、页面协议、调试与发布流程。

注意

由于 Breeze 本体仍在快速开发中,文档可能不会始终及时更新。

具体实现请优先以示例项目为准: https://github.com/deretame/Breeze-plugin-example

如有建议或发现文档问题,请直接提交 issue: https://github.com/deretame/Breeze/issues

文档内容

  • 基于示例仓库直接开工
  • 运行时 API 参考(fetchbridgecrypto 等)
  • 所有 fnPath 的 TypeScript 类型定义与调用语义
  • Scheme + data 页面协议说明
  • 本地联调、调试模式、打包发布流程
  • 交付前检查清单

前置假设

  • 插件运行在 QuickJS-NG 引擎中(不是 Node.js,不是浏览器)
  • 使用 TypeScript 开发插件
  • 使用 Node.js 22+
  • 使用 pnpm 10+(推荐 11+)
  • 构建产物为单文件 bundle(例如 *.bundle.cjs
  • 插件入口采用 export default { ... }

推荐起点

  • 示例仓库:https://github.com/deretame/Breeze-plugin-example

建议直接 clone 示例仓库,在它的基础上改造自己的插件,而不是从空目录自行搭建。

推荐阅读顺序

  1. 快速开始
  2. 运行时 API
  3. 生命周期与结构
  4. 插件 API 契约
  5. 调试与发布
  6. 交付检查清单