# @fiit/record-relay 中文文档

规范地址：https://npmcn.com/package/%40fiit/record-relay/

版本：0\.2\.3
npm 元数据更新时间：2026-08-24T10:20:15.034Z
中文译文更新时间：2026-11-14T17:33:06.360Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40fiit/record-relay
原文对照：https://npmcn.com/package/%40fiit/record-relay/?lang=original

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

- 包体积（解压后）：4.5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-21T09:38:46.924Z
- 最新版本发布：2026-06-16T07:43:51.344Z
- 近 30 天下载量：8193（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

将事件发送到 [记录转发](https://github.com/getfiit/sre-recordrelay) 服务器.

## 安装

```sh
npm install @fiit/record-relay
```

也可以使用：`pnpm add @fiit/record-relay`、`yarn add @fiit/record-relay`、`bun add @fiit/record-relay`

## README

# @fiit/ record-relay (英语)

将事件发送到 [记录转发](https://github.com/getfiit/sre-recordrelay) 服务器.

## 安装

```sh
yarn add @fiit/record-relay
```

## 使用量

```ts
import { createRecordRelayClient } from '@fiit/record-relay';

const relay = createRecordRelayClient({
  baseUrl: 'https://your-relay-server.example.com',
  writeKey: 'your-write-key',
});

await relay.emit('user.signed_in', { userId: '123' });
```

这个 `writeKey` 是一个只写到您的工程的认证范围 —— 包含在浏览器捆绑中是安全的 .

## API 密码

### `createRecordRelayClient(config)`

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `baseUrl` | `string` | 您记录转发服务器的基础 URL |
| `writeKey` | `string` | 工程写入密钥 |

回返a `RecordRelayClient` 采用单一方法:

### `client.emit(event, data)`

发现一个事件。 总是解决——网络错误和非-2xx回复被记录为警告并被吞噬,这样它们就永远不会打断你的应用.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `event` | `string` | 事件名称,例如:. `"user.signed_in"` |
| `data` | `Record<string, unknown>` | 任意事件有效载荷 |

## 常见问题

### @fiit/record-relay 是什么？

将事件发送到 记录转发 服务器\.

### 如何安装 @fiit/record-relay？

在项目目录运行 npm install @fiit/record-relay，或使用 pnpm add / yarn add / bun add。

### @fiit/record-relay 支持 TypeScript 吗？

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

### @fiit/record-relay 支持 ESM 还是 CommonJS？

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

### @fiit/record-relay 可以商用吗？

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

### @fiit/record-relay 的下载量有多少？

根据 npm 官方下载统计，@fiit/record-relay 在 2026/10/15 – 2026/11/13 这 30 天内被下载 8,193 次，日均约 273 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fiit/record-relay 还在维护吗？

最新版本 0\.2\.3 发布于 2026/06/16（4 个月前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/05/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。