# @useairfoil/effect-vcr 中文文档

规范地址：https://npmcn.com/package/%40useairfoil/effect-vcr/

版本：0\.4\.9
npm 元数据更新时间：2026-11-02T18:47:47.969Z
中文译文更新时间：2026-11-02T19:33:33.525Z
软件包许可：未声明

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40useairfoil/effect-vcr
原文对照：https://npmcn.com/package/%40useairfoil/effect-vcr/?lang=original
项目主页：https://github.com/useairfoil/connector-kit#readme
源码仓库：https://github.com/useairfoil/connector-kit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：134 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：effect ^4\.1\.0
- 首次发布：2026-04-24T11:43:29.613Z
- 最新版本发布：2026-11-02T18:47:47.661Z
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

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

## 安装

```sh
npm install @useairfoil/effect-vcr
```

也可以使用：`pnpm add @useairfoil/effect-vcr`、`yarn add @useairfoil/effect-vcr`、`bun add @useairfoil/effect-vcr`

## README

# 影响录像机

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

## 安装

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

## 使用

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

```ts
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 是什么？

这个包记录到磁带文件的效果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 和提交记录判断。