Create a multicast stream that lets multiple consumers independently read the same data

Install

1npm install multicast-stream

Usage

Without this package

Using Readable#text() on a stream can only work with a single consumer. If you try to read the stream with multiple consumers, it will be empty as the stream can only be read once.

1import {Readable} from 'node:stream';
2import {text} from 'node:stream/consumers';
3
4const sourceStream = Readable.from(['Hello', ' ', 'World']);
5const [result1, result2] = await Promise.all([text(sourceStream), text(sourceStream)]);
6
7console.log(result1); // 'Hello World'
8console.log(result2); // ''

With this package

This package allows multiple consumers to independently read the same data from a single source stream.

1import {Readable} from 'node:stream';
2import {text} from 'node:stream/consumers';
3import multicastStream from 'multicast-stream';
4
5const sourceStream = Readable.from(['Hello', ' ', 'World']);
6const createConsumer = multicastStream(sourceStream);
7
8const consumer1 = createConsumer();
9const consumer2 = createConsumer();
10
11const [result1, result2] = await Promise.all([text(consumer1), text(consumer2)]);
12
13console.log(result1); // 'Hello World'
14console.log(result2); // 'Hello World'

API

multicastStream(sourceStream)

Creates a function that returns independent streams for each consumer.

Parameters

• sourceStream (Readable): The source stream to multicast.

Returns

• () => PassThrough: A function that returns a new PassThrough stream for each consumer.