commflow
搜索
K
当前发布版本 0.0.2
产品功能手册(规划 API)
项目
GitHub
npm
简体中文
English
简体中文
主题
语言
简体中文
English
简体中文
菜单
目录
#
文档地图
本页按“当前可运行”和“规划功能”两条用户路径组织文档,帮助你先验证已发布能力,再查阅未来完整功能的使用说明。
#
当前发布版本 0.0.2
文档
何时阅读
当前版本快速开始
安装并运行当前已发布的 manifest API。
Manifest API
查询当前已发布导出、字段和 descriptor 值。
通信能力地图
核对 manifest 与规划 runtime 的能力边界。
FAQ 与排错
处理当前版本、导入、Node 版本和未发布 API 预期问题。
#
规划 API:产品功能手册
文档
何时阅读
产品功能手册(规划 API)
了解规划中的完整功能范围、统一使用模型和功能选择。
功能总览
按未来场景选择 request、SSE、RPC、socket 或 VextJS adapter。
#
规划 API:核心通信功能
文档
何时阅读
Request
发起 HTTP 请求、设置 timeout/retry、target、context、hook。
SSE
订阅服务端事件、处理消息、重连、关闭和释放资源。
RPC
按 procedure 调用服务、传参、处理返回和 typed contract。
Socket
建立长连接、发送消息、监听事件、心跳、重连和关闭。
#
规划 API:配置与错误
文档
何时阅读
配置指南
查询 timeout、retry、headers、target、contextProvider、hooks 等配置。
错误与重试
理解 HTTP 状态、timeout、network、aborted、hook failure、retry 和 reconnect 边界。
#
VextJS:当前替代与规划接入
文档
何时阅读
接入 VextJS
今天使用
app.fetch.create()
+
app.extend()
创建专用 client,并了解规划 adapter 的兼容路径。
#
设计预览
文档
何时阅读
Request 设计草案
查看尚未稳定的 request API 草案;规划功能手册以
Request
为主。
#
推荐阅读顺序
当前版本快速开始
Manifest API
通信能力地图
FAQ 与排错
产品功能手册(规划 API)
功能总览
Request
SSE
RPC
Socket
配置指南
错误与重试
接入 VextJS