cancelable-pump v0.4.0

cancelable-pump

Cancelable pump

const {createReadStream, createWriteStream} = require('cancelable-pump');
const cancelablePump = require('cancelable-pump');

cancelablePump(createReadStream('1GB-file.txt'), createWriteStream('dest0'), () => {
  statSync('dest0').size; //=> 1000000000;
});

const cancel = cancelablePump(createReadStream('1GB-file.txt'), createWriteStream('dest1'), () => {
  statSync('dest1').size; //=> 263192576, or something else smaller than 1000000000
});

setTimeout(() => {
  cancel();
}, 1000);

Installation

Use npm.

npm install cancelable-pump

API

const cancelablePump = require('cancelable-pump');

cancelablePump(stream0 , stream1, stream2, ...)

stream0, stream1, stream2, ...: Stream
callback: Function
Return: Function

cancelablePump(streams , callback)

streams: Array<Stream>
callback: Function
Return: Function

The API is almost the same as pump's. The only difference is cancelable-pump returns a function to destroy all streams without passing any errors to the callback.

const cancel = cancelablePump([src, transform, anotherTransform, dest], err => {
  err; //=> undefined
});

cancel();

License

ISC License © 2017 - 2018 Shinnosuke Watanabe