wow-client 参考
@ahoo-wang/wow-client 是 Wow 服务路由的 TypeScript 客户端,基于 Fetcher:带等待的命令、状态读取、快照查询、事件查询和数据集查询、Manifest,以及服务回答的 problem。wow-generator 写出的客户端构建在它之上。怎样使用它,见 TypeScript 指南;本参考列出它导出什么。
入口
| 入口 | 包含 | 符号 |
|---|---|---|
@ahoo-wang/wow-client | CommandClient 及命令选项、WaitPlan、CommandRejectedError、StateClient、SnapshotQueryClient、EventQueryClient、QueryModelClient、DatasetClient、fetchManifest、WowProblemError 与 FrameworkErrorCodes、wait 的各跳、线上类型和精确数字的 JSON 辅助函数;不含查询 DSL,那是 /dsl 的 | 根入口(英文) |
@ahoo-wang/wow-client/dsl | 只有查询 DSL:filter、aggregation、排序、投影、分页、游标查询、查询工厂、能力描述符的类型和 QueryErrorCodes,没有 Fetcher,也没有 fetcher-eventstream 安装的任何流补丁 | /dsl(英文) |
@ahoo-wang/wow-client/routes | ServiceRoutes:按服务的 Manifest 给出的名字调用服务自己的路由,即处理函数是服务自身代码的那些路由;生成的 <Context>Routes 建立在它之上 | /routes(英文) |
@ahoo-wang/wow-client/testing | 用于测试和开发运行的辅助函数,从不用于生产:commandResultOf、snapshotOf、problemOf 和 problemResponse 构建服务会回答的内容,供假实现使用;developmentCaller 用只有开发运行才读取的请求头,以某个调用方的身份发送每个请求 | /testing(英文) |
当一个 bundle 只构建查询,并通过它自己的客户端发送时,使用 /dsl。
生成的部分
四个符号索引页由包的 scripts/api-report.mjs 从构建出的声明生成:每个导出的名字、它的种类以及它 TSDoc 的第一句话。同一次运行把每个入口的完整签名保存在它的 API 报告 test/api/root.api.md、dsl.api.md、routes.api.md 和 testing.api.md 中,构建结果与提交的报告或页面不同时就会失败。因此对导出面的改动会在审查中显现,报告中的 - 行会给拉取请求打上 breaking-change 标签。