# @ag-ui/encoder 中文文档

规范地址：https://npmcn.com/package/%40ag-ui/encoder/

版本：1\.0\.4
npm 元数据更新时间：2026-11-05T13:34:39.541Z
中文译文更新时间：2026-11-05T16:51:55.695Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：45.4 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：zod ^3\.25\.18 \|\| ^4\.0\.0
- 首次发布：2025-04-30T11:36:33.311Z
- 最新版本发布：2026-11-05T13:34:38.982Z
- 近 30 天下载量：6218226（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 44 个）

## 中文简介

事件编码工具 **代理用户互动(AG-UI)议定书**。 。 。 .

## 安装

```sh
npm install @ag-ui/encoder
```

也可以使用：`pnpm add @ag-ui/encoder`、`yarn add @ag-ui/encoder`、`bun add @ag-ui/encoder`

## README

# @ag-ui/编码器

事件编码工具 **代理用户互动(AG-UI)议定书**。 。 。 .

`@ag-ui/encoder` 处理 AG-UI 事件的内容谈判和格式编码。 它根据客户端自动选择服务器-恒星事件(JSON)和协议缓冲 `Accept` 标头,确保优化运输效率.

## 安装

```bash
npm install @ag-ui/encoder zod
pnpm add @ag-ui/encoder zod
yarn add @ag-ui/encoder zod
```

zod(3.25.18+或4.x)是一种同级依赖. Protobuf 编码验证 与计划相关的事件 `@ag-ui/core/schemas`,使用 zod 应用程序 安装而不是捆绑的副本.

## 特征

-   🎯 **内容谈判** - 以 `Accept` 页眉
-   📦 **双重编码** - SSE(JSON)和协议缓冲支持
-   ⚡ **高效二进制** - 高通量情景的长度前置原生编码
-   🔄 **无缝回落** - 在不支持原生生物的情况下 将基因降解为SSE

## 快速实例

```ts
import { EventEncoder } from "@ag-ui/encoder";
import { EventType } from "@ag-ui/core";

const encoder = new EventEncoder({
  accept: "application/vnd.ag-ui.event+proto, text/event-stream",
});

const event = {
  type: EventType.TEXT_MESSAGE_CONTENT,
  messageId: "msg_123",
  delta: "Hello, world!",
};

// Returns protobuf-encoded binary data
const encoded = encoder.encodeBinary(event);
```

## 文档

-   概念和结构 : [`docs/concepts`](https://docs.ag-ui.com/concepts/architecture)
-   完整 API 参考 : [`docs/sdk/js/encoder`](https://docs.ag-ui.com/sdk/js/encoder)

## 捐款

欢迎虫子报告和拉出请求! 请读我们的 [贡献指南](https://docs.ag-ui.com/development/contributing) 先说.

## 许可证

《麻省理工学院2025 AG-UI议定书》

## 常见问题

### @ag-ui/encoder 是什么？

事件编码工具 代理用户互动\(AG-UI\)议定书。 。 。 \.

### 如何安装 @ag-ui/encoder？

在项目目录运行 npm install @ag-ui/encoder，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^3\.25\.18 \|\| ^4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @ag-ui/encoder 支持 TypeScript 吗？

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

### @ag-ui/encoder 支持 ESM 还是 CommonJS？

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

### @ag-ui/encoder 可以商用吗？

@ag-ui/encoder 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @ag-ui/encoder 的下载量有多少？

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

### @ag-ui/encoder 还在维护吗？

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