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这个承诺会解决的.