pipe streams together and close all of them if one of them closes
JavaScript
Latest commit 90ed7ae Dec 20, 2016 @mafintosh 1.0.2
Permalink
Failed to load latest commit information.
.gitignore first commit Aug 14, 2013
.travis.yml travis May 7, 2014
LICENSE add full license text Aug 21, 2014
README.md be standard Oct 23, 2015
index.js Ignore fs in the browser (#13) Dec 20, 2016
package.json 1.0.2 Dec 20, 2016
test-browser.js add browser test Feb 18, 2016
test.js be standard Oct 23, 2015

README.md

pump

pump is a small node module that pipes streams together and destroys all of them if one of them closes.

npm install pump

build status

What problem does it solve?

When using standard source.pipe(dest) source will not be destroyed if dest emits close or an error. You are also not able to provide a callback to tell when then pipe has finished.

pump does these two things for you

Usage

Simply pass the streams you want to pipe together to pump and add an optional callback

var pump = require('pump')
var fs = require('fs')

var source = fs.createReadStream('/dev/random')
var dest = fs.createWriteStream('/dev/null')

pump(source, dest, function(err) {
  console.log('pipe finished', err)
})

setTimeout(function() {
  dest.destroy() // when dest is closed pump will destroy source
}, 1000)

You can use pump to pipe more than two streams together as well

var transform = someTransformStream()

pump(source, transform, anotherTransform, dest, function(err) {
  console.log('pipe finished', err)
})

If source, transform, anotherTransform or dest closes all of them will be destroyed.

License

MIT

Related

pump is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.