blob: b62fd1d3a9e4de24eaa8cc2a2659d34b21b18d36 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# cloneable-readable
[](https://travis-ci.org/mcollina/cloneable-readable)
Clone a Readable stream, safely.
```js
'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](http://nearform.com).
## License
MIT
|
