unpipe

What is unpipe?

The 'unpipe' npm package is designed to remove or detach a stream from a pipeline. This can be particularly useful in scenarios where you need to gracefully handle stream errors or manipulate the flow of data dynamically. It provides a straightforward API to unpipe streams, which can be beneficial in creating more robust and error-resilient streaming applications.

What are unpipe's main functionalities?

Unpipe a stream

This code demonstrates how to use 'unpipe' to detach a stream when an error occurs. It's useful for preventing memory leaks or unintended data processing after an error.

const unpipe = require('unpipe');
const stream = getSomeReadableStream();
stream.on('error', function(err) {
  unpipe(stream);
});

Other packages similar to unpipe

pump

The 'pump' package is similar to 'unpipe' in that it is used to safely pipe streams together, handling cleanup and errors gracefully. Unlike 'unpipe', which is focused on detaching streams, 'pump' provides a more comprehensive solution for creating and managing stream pipelines, including the ability to safely clean up after streams have ended or errored.

through2

While 'through2' is not directly similar to 'unpipe' in functionality, it offers a simplified wrapper around Node's stream.Transform. It's useful for creating transform streams easily. In comparison, 'unpipe' specifically deals with detaching streams, whereas 'through2' is more about stream creation and transformation.

README

unpipe

Unpipe a stream from all destinations.

Installation

$ npm install unpipe

API

var unpipe = require('unpipe')

unpipe(stream)

Unpipes all destinations from a given stream. With stream 2+, this is equivalent to stream.unpipe(). When used with streams 1 style streams (typically Node.js 0.8 and below), this module attempts to undo the actions done in stream.pipe(dest).

License

MIT