@agent-relay/events

中文文档
7.1.1发布于 2026/05/25TypeScriptES Module构建来源已验证近 30 天下载 3.4万

Agent Relay

中文使用文档
文档目录9 节
  1. 它会做什么
  2. 安装
  3. 快开始
  4. 事件信封形状
  5. 扩展水平
  6. 重试 + 无重试
  7. 打开几何
  8. 相关
  9. 许可证

Agent Relay

@ agent-relay/ events (英语)

用于主动代理的常态事件流——代理中继运行时间的第2层.

npm License

网站: agentrelay.com (英语) • 妇女 文档 : extrelay.com/docs (英语)

它会做什么

@agent-relay/events 将三个主动原始(cron, watch, inbox)变成一个正态的事件流. 单人订阅 onEvent 处理器; 接收可以懒散的轻量级信封 expand() 全部载荷.

它是迁移-不可知核心:没有工作空间概念,没有调度,没有云假设——纯事件流外加再试政策外加OpenTeleometry tracking. 直接为主机 Webhoks 编写, 或者在顶上建立更高层次的运行时间( 见 @agent-relay/agent) (中文(简体) ).

安装

npm install @agent-relay/events

快开始

import { events } from '@agent-relay/events';

const handle = events({
  workspace: 'support',
  apiKey: process.env.RELAY_API_KEY!,
  onEvent: async (event) => {
    console.log(event.type, event.resource.path);

    const full = await event.expand('full');
    // ... act on full.data
  },
});

// ... later
await handle.stop();

事件信封形状

每件事都是正常发生的 AgentEvent数字 :

type AgentEvent = {
  id: string;                           // stable event id
  workspace: string;
  type: 'cron.tick' | 'startup' | 'relayfile.changed' | 'relaycast.message' | ...;
  occurredAt: string;                   // ISO timestamp
  attempt: number;                      // delivery attempt count
  resource: { path: string; kind: string; id: string; provider: string };
  summary: EventSummary;                // <1KB, PII-stripped
  expand: (level: 'summary' | 'full' | 'diff' | 'thread') => Promise<Expansion>;
  digest?: string;
};

信封就是那个 形状您的处理器接收 ——不是完整的供应商有效载荷. 打电话 event.expand('full') 以懒惰地实现资源.

扩展水平

职等你得到的东西费用
summary预先列入的轻量级摘要(已经在活动上)免费
full通过网关/中继文件 VFS 提供完整的教条资源一读
diff已更改的字段对先前状态一读
thread附加评论/答复一个或多个读取

重试 + 无重试

import { events, NoRetry } from '@agent-relay/events';

events({
  workspace: 'support',
  apiKey: process.env.RELAY_API_KEY!,
  onEvent: async (event) => {
    try {
      // ... your work
    } catch (err) {
      if (isPermanent(err)) throw new NoRetry(err); // skip retry queue
      throw err; // 5-attempt exp backoff
    }
  },
});

打开几何

每一次发送的事件都被包裹在 SpanKind.CONSUMER 横跨标记事件编号、类型、工作空间和尝试。 配置您的导出者( 例如 ) . OTEL_EXPORTER_OTLP_ENDPOINT(b) —— @agent-relay/events 通过 : @opentelemetry/api。 。 。 .

许可证

阿帕奇-2.0 — 见 自由主义。 。 。 .

版本与发布记录

@agent-relay/events 共发布 27 个版本,首次发布于 2026/05/13;过去 12 个月发布了 27 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.1.1latest2026/05/255 个月前
7.1.02026/05/235 个月前
7.0.12026/05/225 个月前
6.3.62026/05/225 个月前
7.0.02026/05/225 个月前
6.3.52026/05/225 个月前

关于 @agent-relay/events 的常见问题

如何安装 @agent-relay/events?

在项目目录运行 npm install @agent-relay/events,或使用 pnpm add / yarn add / bun add。

@agent-relay/events 支持 TypeScript 吗?

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

@agent-relay/events 支持 ESM 还是 CommonJS?

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

@agent-relay/events 可以商用吗?

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

@agent-relay/events 的下载量有多少?

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

@agent-relay/events 还在维护吗?

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