# @coveo/relay 中文文档

规范地址：https://npmcn.com/package/%40coveo/relay/

版本：2\.1\.3
npm 元数据更新时间：2026-08-04T14:43:59.260Z
中文译文更新时间：2026-11-10T20:57:05.977Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40coveo/relay
原文对照：https://npmcn.com/package/%40coveo/relay/?lang=original
项目主页：https://github.com/coveo/ui-kit/tree/main/packages/relay#readme
源码仓库：https://github.com/coveo/ui-kit

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

- 包体积（解压后）：120 kB，44 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0
- 运行依赖：2 个
- 首次发布：2022-02-02T23:30:46.634Z
- 最新版本发布：2026-08-04T14:43:58.913Z
- 近 30 天下载量：347302（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：85（近 12 个月 9 个）

## 中文简介

使用 Coveo 事件协议发送分析事件的库 .

## 安装

```sh
npm install @coveo/relay
```

也可以使用：`pnpm add @coveo/relay`、`yarn add @coveo/relay`、`bun add @coveo/relay`

## README

# @ coveo/ 转发

中继是一个用于排放事件协议分析事件的紧凑库. 它简化了相关用户互动的跟踪. 这种分析数据功率报告并帮助训练出科维奥机器学习模型.

## 使用量

首先,在您的项目中创建一个中继实例 。 此实例随后可用于发布事件或进行其他动作.

```js
import { createRelay } from "@coveo/relay";

const config = {...};
const relay = createRelay(config);

const payload = {...};
relay.emit('itemView', payload);
```

## 正式文件

-   [更多地了解中继器](https://docs.coveo.com/en/relay/latest/)
-   [事件 API 计划和参考类型列表](https://docs.coveo.com/en/n9da0377/build-a-search-ui/event-api-reference)

## 常见问题

### @coveo/relay 是什么？

使用 Coveo 事件协议发送分析事件的库 \.

### 如何安装 @coveo/relay？

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

### @coveo/relay 支持 TypeScript 吗？

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

### @coveo/relay 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @coveo/relay 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @coveo/relay 可以商用吗？

@coveo/relay 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @coveo/relay 的下载量有多少？

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

### @coveo/relay 还在维护吗？

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