Skip to content
Pipe queued streams progressively.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(Dependencies): Update meta packages Dec 3, 2017
.readme build(metapak-nfroidure): Add metapak-nfroidure Mar 5, 2017
src chore(Dependencies): Update meta packages Dec 3, 2017
tests chore(Dependencies): Update meta packages Dec 3, 2017
.codeclimate.yml chore(Dependencies): Update meta packages Dec 3, 2017
.editorconfig chore(Dependencies): Update meta packages Dec 3, 2017
.eslintrc.js chore(Dependencies): Update meta packages Dec 3, 2017
.gitattributes
.gitignore chore(Dependencies): Update meta packages Dec 3, 2017
.npmignore Added coverage tests Feb 11, 2014
.prettierrc.js chore(Dependencies): Update meta packages Dec 3, 2017
.travis.yml chore(Dependencies): Update meta packages Dec 3, 2017
CHANGELOG.md 1.1.2 Dec 3, 2017
LICENCE First commit Jan 11, 2014
LICENSE build(metapak-nfroidure): Add metapak-nfroidure Mar 5, 2017
README.md chore(Dependencies): Update meta packages Dec 3, 2017
package-lock.json
package.json 1.1.2 Dec 3, 2017

README.md

streamqueue

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

NPM version Build status Dependency Status devDependency Status Coverage Status Code Climate Dependency Status

## Usage Install the npm module:

npm install streamqueue --save

Then, in your scripts:

var streamqueue = require('streamqueue');

var queue = streamqueue(
  Fs.createReadStream('input.txt'),
  Fs.createReadStream('input2.txt'),
  Fs.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:

var streamqueue = require('streamqueue');

var queue = streamqueue(
  Fs.createReadStream.bind(null, 'input.txt'),
  Fs.createReadStream.bind(null, 'input2.txt'),
  Fs.createReadStream.bind(null, 'input3.txt')
).pipe(process.stdout);

Object-oriented traditionnal API offers more flexibility:

var StreamQueue = require('streamqueue');

var queue = new StreamQueue();
queue.queue(
  Fs.createReadStream('input.txt'),
  Fs.createReadStream('input2.txt'),
  Fs.createReadStream('input3.txt')
);
queue.done();

queue.pipe(process.stdout);

You can also chain StreamQueue methods like that:

var StreamQueue = require('streamqueue');

new StreamQueue()
  .queue(Fs.createReadStream('input.txt'))
  .queue(Fs.createReadStream('input2.txt'))
  .queue(Fs.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.

Note that stream queue is compatible with the Node 0.10+ streams. For older streams, stream queue will wrap them with Readable.wrap before queueing. Please fix your dependencies or report issues to libraries using 0.8 streams since this extra code will finally be removed.

API

StreamQueue([options], [stream1, stream2, ... streamN])

options

options.objectMode

Type: Boolean Default value: false

Use if piped in streams are in object mode. In this case, the stream queue will also be in the object mode.

options.pauseFlowingStream

Type: Boolean Default value: true

If a stream is in flowing mode, then it will be paused before queueing.

options.resumeFlowingStream

Type: Boolean Default value: true

If a stream is in flowing mode, then it will be resumed before piping.

options.*

StreamQueue inherits of Stream.PassThrough, the options are passed to the parent constructor so you can use it's options too.

streamN

Type: Stream

Append streams given in argument to the queue and ends when the queue is empty.

StreamQueue.queue(stream1, [stream2, ... streamN])

Append streams given in argument to the queue.

StreamQueue.done([stream1, stream2, ... streamN])

Append streams given in argument to the queue and ends when the queue is empty.

StreamQueue.obj([options], [stream1, stream2, ... streamN])

A shortcut for StreamQueue({objectMode: true}).

Stats

NPM NPM

Contributing

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

License

MIT

You can’t perform that action at this time.