@graffy/stream

中文文档
0.19.7发布于 2026/09/16Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 7070

用于从任何回调创建 AsyncIterables( 流)

中文使用文档
文档目录6 节
  1. 为什么?
  2. 使用量
  3. 最小示例
  4. 处理上游端
  5. 处理错误
  6. 后压

Graffy 流线

用于从任何回调创建 AsyncIterables( 流) 事件源代码.

为什么?

许多联合材料API提供必须订阅和不订阅的基于召回的事件发送器。 联合来文中的合成生成器语法并不能提供做到这一点的简单机制.

想象一下事件发射器:

websocket.addEventListener('message', callback);

我们想把这串信息输入到一个可同步的信息中,这样我们就可以:

for await (const message of messages) {
  // Do stuff with message.
  if (done) break;
}

做点什么 我们也许也想打电话 removeEventListener 当我们断绝循环的时候.

使用量

默认导出为工厂函数 .

import { makeStream } from '@graffy/stream';

最小示例

此处理来自事件发送器的签名和不签名 .

const stream = makeStream((push) => {
  eventSource.on('event', push);
  return () => eventSource.off('event', push);
});

回报值, stream,是 AsyncIterable,可以用于循环等待.

处理上游端

这处理"上流"事件发射器有"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出"出.

const stream = makeStream((push, end) => {
  eventSource.on('event', (event) => push(event));
  eventSource.on('end', () => end());
  return () => eventSource.close();
});

处理错误

这处理两个方向的错误. "上游"可能与出错相接合,应在下游作为"等待回转"来传达. 少些时候,如果循环内部的代码抛出, 我们可能想在上游传播.

两者均由“ 端” 函数处理, 并使用一个错误对象作为参数 .

const stream = makeStream((push, end) => {
  eventSource.on('event', (event) => push(event));
  eventSource.on('end', () => end());
  eventSource.on('error', (error) => end(error));
  return (error) => {
    if (error) {
      eventSource.closeWithError();
      return;
    }
    eventSource.close();
  };
});

后压

当溪流被用来控制IO事件时,我们可能会遇到下游消费者比上游生产者慢的情况. 如果不加控制,我们可能会失去记忆——我们需要保持一个未完结事件的缓冲.

为了处理这种情况,制片人可能暴露出暂停和恢复事件流的方法;如果不是,在某些情况下,也可以不订阅并重新订阅.

Graffy溪流暴露出一个界面来做这些,其可配置的高低水分.

const stream = makeStream(
  (push) => {
    eventSource.on('event', (event) => {
      const wait = push(event);
      if (wait) {
        eventSource.pause();
        wait.then(() => eventSource.resume());
      }
    });

    return () => eventSource.close();
  },
  { highWatermark: 255, lowWatermark: 4 },
);

如果有超过 highWatermark 未完成的事件, push() 誓以报应 wait随着消费者赶上,未完结事件的数量降到以下 lowWatermark这个承诺会解决的.

版本与发布记录

@graffy/stream 共发布 246 个版本,首次发布于 2019/09/07;过去 12 个月发布了 21 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.19.7latest2026/09/162 个月前
0.19.62026/08/173 个月前
0.19.52026/08/033 个月前
0.19.42026/06/304 个月前
0.19.32026/05/215 个月前
0.19.22026/05/176 个月前

其他发布通道:pre → 0.19.1-alpha.3。

关于 @graffy/stream 的常见问题

@graffy/stream 是什么?

用于从任何回调创建 AsyncIterables( 流)

如何安装 @graffy/stream?

在项目目录运行 npm install @graffy/stream,或使用 pnpm add / yarn add / bun add。

@graffy/stream 支持 TypeScript 吗?

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

@graffy/stream 支持 ESM 还是 CommonJS?

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

@graffy/stream 可以商用吗?

@graffy/stream 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@graffy/stream 的下载量有多少?

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

@graffy/stream 还在维护吗?

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