@useairfoil/effect-vcr

中文文档
0.4.9发布于 2026/11/03TypeScriptES Module构建来源已验证

这个包记录到磁带文件的效果HTTP请求。测试可以在以后重播相同的请求。

中文使用文档
文档目录3 节
  1. 安装
  2. 使用
  3. 配置

影响录像机

这个包记录到磁带文件的效果HTTP请求。测试可以重放 之后会有同样的请求。

安装

pnpm add -D @useairfoil/effect-vcr @effect/platform-node@^4 effect@^4

使用

使用 VcrHttpClient.layer(...) 围绕实时效果HTTP客户端和 FileSystemCassetteStore.layer(...) 磁带文件。

import { NodeServices } from "@effect/platform-node";
import { FileSystemCassetteStore, VcrHttpClient } from "@useairfoil/effect-vcr";
import { Layer } from "effect";
import { FetchHttpClient } from "effect/http";

const store = FileSystemCassetteStore.layer().pipe(Layer.provide(NodeServices.layer));

const VcrLive = VcrHttpClient.layer({
  vcrName: "provider-api",
  mode: "auto",
}).pipe(Layer.provide(Layer.mergeAll(FetchHttpClient.layer, NodeServices.layer, store)));

自动模式回放录音带,如果它是存在的。如果丢失,它会记录1。 在CI上,丢失的卡带失效。 ACK_DISABLE_VCR=* 跳过VCR,使用直播 HTTP。

请求匹配方法、URL及其查询参数、标题和正文。 授权头在匹配时被忽略,并在卡带之前被删除 是写的。添加其他秘密 redact。中列出的查询参数 redact.requestQueryParams 从卡带中取出并被忽略 匹配,当参数来自本地配置时也会有所帮助。

请求可以同时记录。磁带写入是轮流的,所以没有输入 是输了。

配置

变量要求默认的
CI否false
ACK_DISABLE_VCR否空

版本与发布记录

@useairfoil/effect-vcr 共发布 12 个版本,首次发布于 2026/04/24;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.9latest2026/11/03今天
0.4.82026/10/295 天前
0.4.72026/10/295 天前
0.4.62026/08/142 个月前
0.4.52026/08/142 个月前
0.4.42026/08/142 个月前

关于 @useairfoil/effect-vcr 的常见问题

@useairfoil/effect-vcr 是什么?

这个包记录到磁带文件的效果HTTP请求。测试可以在以后重播相同的请求。

如何安装 @useairfoil/effect-vcr?

在项目目录运行 npm install @useairfoil/effect-vcr,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:effect(^4.1.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@useairfoil/effect-vcr 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@useairfoil/effect-vcr 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@useairfoil/effect-vcr 可以商用吗?

@useairfoil/effect-vcr 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@useairfoil/effect-vcr 还在维护吗?

最新版本 0.4.9 发布于 2026/11/03(今天);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/04/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。