Streamqueue NPM

streamqueue

StreamQueue pipe the queued streams one by one in order to preserve their content order.

Usage

npm install streamqueue --save

Then, in your scripts:

import { StreamQueue } from 'streamqueue';
import { createReadStream } from 'node:fs';

const queue = new StreamQueue(
  createReadStream('input.txt'),
  createReadStream('input2.txt'),
  createReadStream('input3.txt'),
).pipe(process.stdout);

StreamQueue also accept functions returning streams, the above can be written like this, doing system calls only when piping:

import { queueStreams } = require('streamqueue');
import { createReadStream } from 'node:fs';

const queue = queueStreams(
  createReadStream.bind(null, 'input.txt'),
  createReadStream.bind(null, 'input2.txt'),
  createReadStream.bind(null, 'input3.txt'),
).pipe(process.stdout);

Object-oriented traditionnal API offers more flexibility:

import { StreamQueue } from 'streamqueue';
import { createReadStream } from 'node:fs';

const queue = new StreamQueue();

queue.queue(
  createReadStream('input.txt'),
  createReadStream('input2.txt'),
  createReadStream('input3.txt'),
);
queue.done();

queue.pipe(process.stdout);

You can also chain StreamQueue methods like that:

import StreamQueue from 'streamqueue';
import { createReadStream } from 'node:fs';

new StreamQueue()
  .queue(createReadStream('input.txt'))
  .queue(createReadStream('input2.txt'))
  .queue(createReadStream('input3.txt'))
  .done()
  .pipe(process.stdout);

You can queue new streams at any moment until you call the done() method. So the created stream will not fire the end event until done() call.

Stats

Contributing

Feel free to propose your code if you agree with publishing it under the MIT license.

API

Classes

Functions

StreamQueue

Pipe queued streams sequentially

Kind: global class

StreamQueue

new StreamQueue(options, ...streams)

Create a new queue and pipe given streams and end if some

Returns: StreamQueue

Param	Type	Description
options	Object	The queue options
options.objectMode	boolean	Operate in object mode
options.pauseFlowingStream	boolean	Pause given streams that are flowing
options.resumeFlowingStream	boolean	Resume given streams that are flowing
...streams	Readable \| function	The stream or stream returning function to pipe in