SuperAPI AI 工具集

effect

通用与其它

查看项目

更新于 10-16 09:29

技能介绍

用途:为使用 Effect v4 构建生产级 TypeScript 应用提供有明确倾向的实践指南,覆盖工作流、服务、Layer、Schema 等实现方式。资料说明该技能以 Effect 4.0.0(上游提交 6389d9ac6)为审查基准;从 v3 或 v4 预览版升级时需阅读 references/V4_APIS.md,且以已安装版本为准,预览版 API 与导入路径可能不同。项目既有约定优先,除非任务明确要求改变。

主要能力:按任务分支提供参考文件,包括 SCHEMA.md(数据模型、Schema、brand、变体、可选键、解码器)、SERVICES_LAYERS.md(服务、模块接口、Layer、运行时装配、错误、Effect.fn、测试服务)、CONFIG.md(运行时配置、环境变量、ConfigProvider、layerConfig)、SCHEDULING.md(重试、重复、轮询、退避、抖动、限流感知策略)、CACHING.md(记忆化、按 key TTL 缓存、并发查询去重、请求批处理)、STREAMS.md(流、事件源、异步可迭代、队列/PubSub、分页、背压、流消费者)、HTTP_CLIENTS.md(出站 HTTP、Effect HttpClient、状态处理、HTTP 限流)、TESTING.md(Effect 测试、时间、sleep、并发同步、假件)。

必要用法:核心默认包括用 Effect.gen(function* () { ... }) 组合工作流;用 Effect.fn("Domain.operation") 定义公开与非平凡内部服务方法;内部辅助用 Effect.fnUntraced;服务优先用 Context.Service;用 Layer.effect(Service, Effect.gen(...)) 构建实现并返回 Service.of({ ... });记录用 Schema.Struct(...) 加同名 interface;类型化错误用 Schema.TaggedError;运行时配置通过 Config 读取而非直接访问 process.env;重试、重复、轮询、节流、退避用 Schedule;随时间发多值且需要拉取、背压、中断或转换的效果源用 Stream;出站 HTTP 优先 Effect HTTP 客户端模块;测试优先 Effect 感知测试、显式 Layer 与确定性同步而非 sleep;未知线上输入用 Schema.decodeUnknownEffect(...) 解码。

边界与限制:HTTP 处理器保持精简,业务规则放在服务或领域函数中;外部集成在适配器边界用命名 effect 包装;持久化数据解码需谨慎;供应商/网络调用不应置于权威数据库事务内;仅在当前边界有真实响应时捕获或重试;仅对已证明幂等的操作重试。资料还列出禁止事项,如不得用 as any、非空断言或未经检查的转换压制类型问题,不得默认引入 Schema.Class 或 Schema.TaggedClass 作为应用数据建模模式,不得在 Schema.TaggedError 适用时手写 _tag 错误类,不得盲目使用 Layer.mergeAll 或 provideMerge,不得用 Context.Reference 默认值隐藏必需的应用权限、凭据、持久化、传输或外部服务,不得在测试中随意添加 Effect.sleep,不得在 effect/Cache 适用时手写 Map/TTL/裁剪缓存或进行中请求去重。具体安装命令、收费与平台信息暂未提供。