Stream.shareProtocol

• 值:Symbol.for('Stream.shareProtocol')

该值必须是一个函数。当被 Share.from() 调用时,它会接收传递给 Share.from() 的选项,并且必须返回一个符合 Share 接口的对象。实现完全自定义——它可以以任何方式管理共享源、消费者、缓冲和背压。

🌐 The value must be a function. When called by Share.from(), it receives the options passed to Share.from() and must return an object conforming to the Share interface. The implementation is fully custom -- it can manage the shared source, consumers, buffering, and backpressure however it wants.

import { share, Share, text } from 'node:stream/iter';
// This example defers to the built-in share(), but a custom
// implementation could use any mechanism.
class DataPool {
 #share;
 constructor(source) {
 this.#share = share(source);
 }
 [Symbol.for('Stream.shareProtocol')](options) {
 return this.#share;
 }
}
const pool = new DataPool(
 (async function* () {
 yield 'hello';
 })(),
);
const shared = Share.from(pool);
const consumer = shared.pull();
console.log(await text(consumer)); // 'hello'const { share, Share, text } = require('node:stream/iter');
// This example defers to the built-in share(), but a custom
// implementation could use any mechanism.
class DataPool {
 #share;
 constructor(source) {
 this.#share = share(source);
 }
 [Symbol.for('Stream.shareProtocol')](options) {
 return this.#share;
 }
}
const pool = new DataPool(
 (async function* () {
 yield 'hello';
 })(),
);
const shared = Share.from(pool);
const consumer = shared.pull();
text(consumer).then(console.log); // 'hello'拷贝