# @framers/agentos-ext-notifications 中文文档

规范地址：https://npmcn.com/package/%40framers/agentos-ext-notifications/

版本：0\.1\.7
npm 元数据更新时间：2026-11-11T07:55:01.919Z
中文译文更新时间：2026-11-15T12:23:21.166Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40framers/agentos-ext-notifications
原文对照：https://npmcn.com/package/%40framers/agentos-ext-notifications/?lang=original
项目主页：https://github.com/framerslab/agentos-extensions/tree/master/registry/curated/communications/notifications#readme
源码仓库：https://github.com/framerslab/agentos-extensions

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

- 包体积（解压后）：57.7 kB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- peer 依赖：@framers/agentos \>=0\.10\.40
- 首次发布：2026-05-02T11:35:02.792Z
- 最新版本发布：2026-11-11T07:55:01.497Z
- 近 30 天下载量：20277（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

AgentOS的统一多频道通知路由器——在所有已配置的频道中发送,广播,以及调度通知.

## 安装

```sh
npm install @framers/agentos-ext-notifications
```

也可以使用：`pnpm add @framers/agentos-ext-notifications`、`yarn add @framers/agentos-ext-notifications`、`bun add @framers/agentos-ext-notifications`

## README

# 通知

这包提供了代理工具 发送,广播,和调度通知 通过包的 `NotificationService`。交付使用注册频道调用.

## 安装

```bash
npm install @framers/agentos-ext-notifications
```

同伴依赖 : `@framers/agentos` 有范围 `>=0.10.40`。 。 。 .

## 使用量

```ts
import { AgentOS } from '@framers/agentos';

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [{ package: '@framers/agentos-ext-notifications' }],
  },
});
```

## 工具

| 工具 | 它会做什么 |
| --- | --- |
| `notifySend` | 通过指定频道或可用最高优先级频道发送通知. |
| `notifyBroadcast` | 向所有注册频道或指定的子集广播通知. |
| `notifySchedule` | 附表、取消或列出待发通知. |

### `notifySend`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `channel` | `string` | 没有 | 目标频道ID。 如果省略,则使用最高优先频道. |
| `message` | `string` | 对 | 通知正文. |
| `subject` | `string` | 没有 | 通知的任择主题或标题. |
| `metadata` | `object` | 没有 | 任意元数据传输到频道. |

### `notifyBroadcast`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `message` | `string` | 对 | 通知正文. |
| `subject` | `string` | 没有 | 通知的任择主题或标题. |
| `channels` | `array` 联 合 国 `string` | 没有 | 要瞄准的频道标识子集 。 如果省略,则使用所有已注册的频道. |
| `metadata` | `object` | 没有 | 任意元数据传输到每个频道. |

### `notifySchedule`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `action` | `string`, enum: (中文(简体) ) `schedule`, (中文(简体) ), `cancel`, (中文(简体) ), `list` | 对 | 要执行的动作:"计划"创建,"取消"删除,或"列表"查看待发通知. |
| `channel` | `string` | 没有 | 目标通道 id(与"计划"动作一起使用). |
| `message` | `string` | 没有 | 通知正文("时间表"行动需要). |
| `subject` | `string` | 没有 | 可选主题或标题(与"时间表"动作一起使用). |
| `sendAt` | `string` | 没有 | ISO 8601 发送时的时标(需要用于"调度"动作). |
| `scheduleId` | `string` | 没有 | 计划 ID 取消("取消"动作需要). |

## 页:1

-   工厂没有读取选项、秘密或环境变量。 它以空通道注册创建服务,不会在返回的包中暴露该服务.
-   导出 `NotificationService` 支持 `registerChannel`, (中文(简体) ), `unregisterChannel`,以及 `listChannels`频道用品 `id`, (中文(简体) ), `name`, (中文(简体) ), `priority`,则a `sendFn` 调用。 导出的工具类接受其构建器中的服务实例 .
-   发送引用频道的 `sendFn` 信息、主题和元数据。 缺少一个频道 `notifySend` 返回时 `success: false`。没有注册频道,发送失败的"没有注册通知频道".
-   广播按顺序发送到频道,在请求的子集中跳过未知的ID,如果没有目标频道存在则失败.
-   频道调用失败显示为 `delivered: false` 带有返回数据出错。 发送和广播工具仍然返回 `success: true` 当服务返回这些交付结果.
-   将通知存储在内存和用途 `setTimeout`。过去 `sendAt` 启动不等待的交付。 取消营业取消,取消待通知.
-   行动检查时间表 `message` 财务报告和审定财务报表 `sendAt`; 取消动作检查 `scheduleId`。这些字段在输入计划中仍然是可选的.
-   预定交付失败被吞并,待交付尝试后取出.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @framers/agentos-ext-notifications 是什么？

AgentOS的统一多频道通知路由器——在所有已配置的频道中发送,广播,以及调度通知\.

### 如何安装 @framers/agentos-ext-notifications？

在项目目录运行 npm install @framers/agentos-ext-notifications，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@framers/agentos（\>=0\.10\.40）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @framers/agentos-ext-notifications 支持 TypeScript 吗？

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

### @framers/agentos-ext-notifications 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @framers/agentos-ext-notifications 需要什么版本的 Node\.js？

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

### @framers/agentos-ext-notifications 可以商用吗？

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

### @framers/agentos-ext-notifications 的下载量有多少？

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

### @framers/agentos-ext-notifications 还在维护吗？

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