Clone a Readable stream, safely
Clone or download
Latest commit 49937bc Aug 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Added a big file test Mar 5, 2018
.npmignore Added "big" to npmignore Mar 5, 2018
.travis.yml Support only Node 6, 8 and 10. Aug 12, 2018
LICENSE Initial commit Apr 26, 2016
README.md docs(readme): add Greenkeeper badge Mar 9, 2018
big Added a big file test Mar 5, 2018
example.js Initial implementation. Apr 26, 2016
index.js Updated readable-stream@3 Aug 12, 2018
package.json Bumped v2.0.0 Aug 13, 2018
test.js Updated readable-stream@3 Aug 12, 2018

README.md

cloneable-readable

Greenkeeper badge

Build Status

Clone a Readable stream, safely.

'use strict'

var cloneable = require('cloneable-readable')
var fs = require('fs')
var pump = require('pump')

var stream = cloneable(fs.createReadStream('./package.json'))

pump(stream.clone(), fs.createWriteStream('./out1'))

// simulate some asynchronicity
setImmediate(function () {
  pump(stream, fs.createWriteStream('./out2'))
})

cloneable-readable automatically handles objectMode: true.

This module comes out of an healthy discussion on the 'right' way to clone a Readable in https://github.com/gulpjs/vinyl/issues/85 and https://github.com/nodejs/readable-stream/issues/202. This is my take.

YOU MUST PIPE ALL CLONES TO START THE FLOW

You can also attach 'data' and 'readable' events to them.

API

cloneable(stream)

Create a Cloneable stream. A Cloneable has a clone() method to create more clones. All clones must be resumed/piped to start the flow.

cloneable.isCloneable(stream)

Check if stream needs to be wrapped in a Cloneable or not.

Acknowledgements

This project was kindly sponsored by nearForm.

License

MIT