Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ordered-read-streams

gulpjs7.4mMIT2.0.0

Combines array of streams into one Readable stream in strict order.

streams, ordered, group, combine, streamx, readable

readme

ordered-read-streams

NPM version Downloads Build Status Coveralls Status

Combines array of streams into one Readable stream in strict order.

Usage

var { Readable } = require('streamx');
var ordered = require('ordered-read-streams');

var s1 = new Readable({
  read: function (cb) {
    var self = this;
    if (self.called) {
      self.push(null);
      return cb(null);
    }
    setTimeout(function () {
      self.called = true;
      self.push('stream 1');
      cb(null);
    }, 200);
  },
});
var s2 = new Readable({
  read: function (cb) {
    var self = this;
    if (self.called) {
      self.push(null);
      return cb(null);
    }
    setTimeout(function () {
      self.called = true;
      self.push('stream 2');
      cb(null);
    }, 30);
  },
});
var s3 = new Readable({
  read: function (cb) {
    var self = this;
    if (self.called) {
      self.push(null);
      return cb(null);
    }
    setTimeout(function () {
      self.called = true;
      self.push('stream 3');
      cb(null);
    }, 100);
  },
});

var readable = ordered([s1, s2, s3]);
readable.on('data', function (data) {
  console.log(data);
  // Logs:
  // stream 1
  // stream 2
  // stream 3
});

API

ordered(streams, [options])

Takes an array of Readable streams and produces a single OrderedReadable stream that will consume the provided streams in strict order. The produced Readable stream respects backpressure on itself and any provided streams.

orderedReadable.addSource(stream)

The returned Readable stream has an addSource instance function that takes appends a Readable stream to the list of source streams that the OrderedReadable is reading from.

License

MIT

changelog

Changelog

2.0.0 (2022-10-10)

⚠ BREAKING CHANGES

  • Avoid eagerly reading streams
  • Destroy all streams correctly when another is destroyed
  • Switch to streamx (#27)
  • Normalize repository, dropping node <10.13 support (#25)

Features

  • Avoid eagerly reading streams (edb9aa1)
  • Ensure readable does not end until read from (87c871c)
  • Provide addSource function on the OrderedReadable stream (#28) (87c871c)
  • Switch to streamx (#27) (edb9aa1)

Bug Fixes

  • Destroy all streams correctly when another is destroyed (edb9aa1)

Miscellaneous Chores

  • Normalize repository, dropping node <10.13 support (#25) (f6e5671)