www.aleph1.co.uk Git - yaffs-website/blob - node_modules/ordered-read-streams/README.md

   1 # ordered-read-streams [![NPM version](https://badge.fury.io/js/ordered-read-streams.png)](http://badge.fury.io/js/ordered-read-streams) [![Build Status](https://travis-ci.org/armed/ordered-read-streams.png?branch=master)](https://travis-ci.org/armed/ordered-read-streams)
   2
   3 Combines array of streams into one read stream in strict order.
   4
   5 ## Installation
   6
   7 `npm install ordered-read-streams`
   8
   9 ## Overview
  10
  11 `ordered-read-streams` handles all data/errors from input streams in parallel, but emits data/errors in strict order in which streams are passed to constructor. This is `objectMode = true` stream.
  12
  13 ## Example
  14
  15 ```js
  16 var through = require('through2');
  17 var Ordered = require('ordered-read-streams');
  18
  19 var s1 = through.obj(function (data, enc, next) {
  20   var self = this;
  21   setTimeout(function () {
  22     self.push(data);
  23     next();
  24   }, 200)
  25 });
  26 var s2 = through.obj(function (data, enc, next) {
  27   var self = this;
  28   setTimeout(function () {
  29     self.push(data);
  30     next();
  31   }, 30)
  32 });
  33 var s3 = through.obj(function (data, enc, next) {
  34   var self = this;
  35   setTimeout(function () {
  36     self.push(data);
  37     next();
  38   }, 100)
  39 });
  40
  41 var streams = new Ordered([s1, s2, s3]);
  42 streams.on('data', function (data) {
  43   console.log(data);
  44 })
  45
  46 s1.write('stream 1');
  47 s1.end();
  48
  49 s2.write('stream 2');
  50 s2.end();
  51
  52 s3.write('stream 3');
  53 s3.end();
  54 ```
  55 Ouput will be:
  56
  57 ```
  58 stream 1
  59 stream 2
  60 stream 3
  61 ```
  62
  63 ## Licence
  64
  65 MIT