stream-combiner2

What is stream-combiner2?

The stream-combiner2 npm package allows you to combine multiple streams into a single stream. This is particularly useful for creating complex data processing pipelines where data flows through multiple transformations.

What are stream-combiner2's main functionalities?

Combining multiple streams

This code demonstrates how to combine a readable stream, a transform stream, and a writable stream using stream-combiner2. The readable stream generates data, the transform stream modifies the data, and the writable stream outputs the final result.

const combine = require('stream-combiner2');
const { Readable, Transform, Writable } = require('stream');

const readable = new Readable({
  read() {
    this.push('data');
    this.push(null);
  }
});

const transform = new Transform({
  transform(chunk, encoding, callback) {
    this.push(chunk.toString().toUpperCase());
    callback();
  }
});

const writable = new Writable({
  write(chunk, encoding, callback) {
    console.log(chunk.toString());
    callback();
  }
});

const combinedStream = combine(readable, transform, writable);
combinedStream.on('finish', () => console.log('Stream processing completed.'));

Other packages similar to stream-combiner2

multipipe

The multipipe package also allows you to combine multiple streams into a single stream. It is similar to stream-combiner2 but offers a slightly different API. Both packages are used for creating stream pipelines, but multipipe is known for its simplicity and ease of use.

pump

The pump package is another alternative for combining streams. It focuses on handling stream errors and cleanup, making it a robust choice for stream management. While stream-combiner2 is more focused on combining streams, pump provides additional features for error handling and resource management.

mississippi

The mississippi package is a collection of useful stream utility functions, including a method for combining streams. It offers a more comprehensive set of tools for working with streams compared to stream-combiner2, which is specialized in stream combination.

README

stream-combiner2

This is a sequel to stream-combiner for streams3.

var combine = require('stream-combiner2')

Combine (stream1,...,streamN)

Turn a pipeline into a single stream. Combine returns a stream that writes to the first stream and reads from the last stream.

Streams1 streams are automatically upgraded to be streams3 streams.

Listening for 'error' will recieve errors from all streams inside the pipe.

var Combine = require('stream-combiner')
var es      = require('event-stream')

Combine(                                  // connect streams together with `pipe`
  process.openStdin(),                    // open stdin
  es.split(),                             // split stream to break on newlines
  es.map(function (data, callback) {      // turn this async function into a stream
    var repr = inspect(JSON.parse(data))  // render it nicely
    callback(null, repr)
  }),
  process.stdout                          // pipe it to stdout !
)

License

MIT