diff options
Diffstat (limited to 'node_modules/end-of-stream/README.md')
| -rw-r--r-- | node_modules/end-of-stream/README.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/node_modules/end-of-stream/README.md b/node_modules/end-of-stream/README.md index df800c1eb..f2560c939 100644 --- a/node_modules/end-of-stream/README.md +++ b/node_modules/end-of-stream/README.md @@ -7,34 +7,35 @@ A node module that calls a callback when a readable/writable/duplex stream has c ## Usage Simply pass a stream and a callback to the `eos`. -Both legacy streams and streams2 are supported. +Both legacy streams, streams2 and stream3 are supported. ``` js var eos = require('end-of-stream'); eos(readableStream, function(err) { + // this will be set to the stream instance if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended'); + console.log('stream has ended', this === readableStream); }); eos(writableStream, function(err) { if (err) return console.log('stream had an error or closed early'); - console.log('stream has finished'); + console.log('stream has finished', this === writableStream); }); eos(duplexStream, function(err) { if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended and finished'); + console.log('stream has ended and finished', this === duplexStream); }); eos(duplexStream, {readable:false}, function(err) { if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended but might still be writable'); + console.log('stream has finished but might still be readable'); }); eos(duplexStream, {writable:false}, function(err) { if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended but might still be readable'); + console.log('stream has ended but might still be writable'); }); eos(readableStream, {error:false}, function(err) { @@ -44,4 +45,8 @@ eos(readableStream, {error:false}, function(err) { ## License -MIT
\ No newline at end of file +MIT + +## Related + +`end-of-stream` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. |