pax_global_header00006660000000000000000000000064146702465400014522gustar00rootroot0000000000000052 comment=16e858ed6594ef22f8daade05613d3a9b0e3a139 pump-3.0.2/000077500000000000000000000000001467024654000125055ustar00rootroot00000000000000pump-3.0.2/.github/000077500000000000000000000000001467024654000140455ustar00rootroot00000000000000pump-3.0.2/.github/FUNDING.yml000066400000000000000000000000471467024654000156630ustar00rootroot00000000000000github: mafintosh tidelift: "npm/pump" pump-3.0.2/.gitignore000066400000000000000000000000151467024654000144710ustar00rootroot00000000000000node_modules pump-3.0.2/.travis.yml000066400000000000000000000000721467024654000146150ustar00rootroot00000000000000language: node_js node_js: - "0.10" script: "npm test" pump-3.0.2/LICENSE000066400000000000000000000020661467024654000135160ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2014 Mathias Buus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.pump-3.0.2/README.md000066400000000000000000000046211467024654000137670ustar00rootroot00000000000000# 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](http://img.shields.io/travis/mafintosh/pump.svg?style=flat)](http://travis-ci.org/mafintosh/pump) ## 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 ``` js 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 ``` js 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. Similarly to `stream.pipe()`, `pump()` returns the last stream passed in, so you can do: ``` return pump(s1, s2) // returns s2 ``` Note that `pump` attaches error handlers to the streams to do internal error handling, so if `s2` emits an error in the above scenario, it will not trigger a `proccess.on('uncaughtException')` if you do not listen for it. If you want to return a stream that combines *both* s1 and s2 to a single stream use [pumpify](https://github.com/mafintosh/pumpify) instead. ## License MIT ## Related `pump` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. ## For enterprise Available as part of the Tidelift Subscription. The maintainers of pump and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-pump?utm_source=npm-pump&utm_medium=referral&utm_campaign=enterprise) pump-3.0.2/SECURITY.md000066400000000000000000000003011467024654000142700ustar00rootroot00000000000000## Security contact information To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. pump-3.0.2/index.js000066400000000000000000000043131467024654000141530ustar00rootroot00000000000000var once = require('once') var eos = require('end-of-stream') var fs try { fs = require('fs') // we only need fs to get the ReadStream and WriteStream prototypes } catch (e) {} var noop = function () {} var ancient = /^v?\.0/.test(process.version) var isFn = function (fn) { return typeof fn === 'function' } var isFS = function (stream) { if (!ancient) return false // newer node version do not need to care about fs is a special way if (!fs) return false // browser return (stream instanceof (fs.ReadStream || noop) || stream instanceof (fs.WriteStream || noop)) && isFn(stream.close) } var isRequest = function (stream) { return stream.setHeader && isFn(stream.abort) } var destroyer = function (stream, reading, writing, callback) { callback = once(callback) var closed = false stream.on('close', function () { closed = true }) eos(stream, {readable: reading, writable: writing}, function (err) { if (err) return callback(err) closed = true callback() }) var destroyed = false return function (err) { if (closed) return if (destroyed) return destroyed = true if (isFS(stream)) return stream.close(noop) // use close for fs streams to avoid fd leaks if (isRequest(stream)) return stream.abort() // request.destroy just do .end - .abort is what we want if (isFn(stream.destroy)) return stream.destroy() callback(err || new Error('stream was destroyed')) } } var call = function (fn) { fn() } var pipe = function (from, to) { return from.pipe(to) } var pump = function () { var streams = Array.prototype.slice.call(arguments) var callback = isFn(streams[streams.length - 1] || noop) && streams.pop() || noop if (Array.isArray(streams[0])) streams = streams[0] if (streams.length < 2) throw new Error('pump requires two streams per minimum') var error var destroys = streams.map(function (stream, i) { var reading = i < streams.length - 1 var writing = i > 0 return destroyer(stream, reading, writing, function (err) { if (!error) error = err if (err) destroys.forEach(call) if (reading) return destroys.forEach(call) callback(error) }) }) return streams.reduce(pipe) } module.exports = pump pump-3.0.2/package-lock.json000066400000000000000000000022271467024654000157240ustar00rootroot00000000000000{ "name": "pump", "version": "3.0.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pump", "version": "3.0.2", "license": "MIT", "dependencies": { "end-of-stream": "^1.1.0", "once": "^1.3.1" } }, "node_modules/end-of-stream": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", "dependencies": { "once": "^1.4.0" } }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", "dependencies": { "wrappy": "1" } }, "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" } } } pump-3.0.2/package.json000066400000000000000000000010221467024654000147660ustar00rootroot00000000000000{ "name": "pump", "version": "3.0.2", "repository": "git://github.com/mafintosh/pump.git", "license": "MIT", "description": "pipe streams together and close all of them if one of them closes", "browser": { "fs": false }, "keywords": [ "streams", "pipe", "destroy", "callback" ], "author": "Mathias Buus Madsen ", "dependencies": { "end-of-stream": "^1.1.0", "once": "^1.3.1" }, "scripts": { "test": "node test-browser.js && node test-node.js" } } pump-3.0.2/test-browser.js000066400000000000000000000022241467024654000155030ustar00rootroot00000000000000var stream = require('stream') var pump = require('./index') var rs = new stream.Readable() var ws = new stream.Writable() rs._read = function (size) { this.push(Buffer(size).fill('abc')) } ws._write = function (chunk, encoding, cb) { setTimeout(function () { cb() }, 100) } var toHex = function () { var reverse = new (require('stream').Transform)() reverse._transform = function (chunk, enc, callback) { reverse.push(chunk.toString('hex')) callback() } return reverse } var wsClosed = false var rsClosed = false var callbackCalled = false var check = function () { if (wsClosed && rsClosed && callbackCalled) { console.log('test-browser.js passes') clearTimeout(timeout) } } ws.on('finish', function () { wsClosed = true check() }) rs.on('end', function () { rsClosed = true check() }) var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { callbackCalled = true check() }) if (res !== ws) { throw new Error('should return last stream') } setTimeout(function () { rs.push(null) rs.emit('close') }, 1000) var timeout = setTimeout(function () { check() throw new Error('timeout') }, 5000) pump-3.0.2/test-node.js000066400000000000000000000017401467024654000147470ustar00rootroot00000000000000var pump = require('./index') var rs = require('fs').createReadStream('/dev/random') var ws = require('fs').createWriteStream('/dev/null') var toHex = function () { var reverse = new (require('stream').Transform)() reverse._transform = function (chunk, enc, callback) { reverse.push(chunk.toString('hex')) callback() } return reverse } var wsClosed = false var rsClosed = false var callbackCalled = false var check = function () { if (wsClosed && rsClosed && callbackCalled) { console.log('test-node.js passes') clearTimeout(timeout) } } ws.on('close', function () { wsClosed = true check() }) rs.on('close', function () { rsClosed = true check() }) var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { callbackCalled = true check() }) if (res !== ws) { throw new Error('should return last stream') } setTimeout(function () { rs.destroy() }, 1000) var timeout = setTimeout(function () { throw new Error('timeout') }, 5000)