end-of-stream

A node module that calls a callback when a readable/writable/duplex stream has completed or failed.

npm install end-of-stream

Usage

Simply pass a stream and a callback to the eos. Both legacy streams, streams2 and stream3 are supported.

1var eos = require('end-of-stream');
2
3eos(readableStream, function(err) {
4  // this will be set to the stream instance
5	if (err) return console.log('stream had an error or closed early');
6	console.log('stream has ended', this === readableStream);
7});
8
9eos(writableStream, function(err) {
10	if (err) return console.log('stream had an error or closed early');
11	console.log('stream has finished', this === writableStream);
12});
13
14eos(duplexStream, function(err) {
15	if (err) return console.log('stream had an error or closed early');
16	console.log('stream has ended and finished', this === duplexStream);
17});
18
19eos(duplexStream, {readable:false}, function(err) {
20	if (err) return console.log('stream had an error or closed early');
21	console.log('stream has finished but might still be readable');
22});
23
24eos(duplexStream, {writable:false}, function(err) {
25	if (err) return console.log('stream had an error or closed early');
26	console.log('stream has ended but might still be writable');
27});
28
29eos(readableStream, {error:false}, function(err) {
30	// do not treat emit('error', err) as a end-of-stream
31});

License

MIT

Related

end-of-stream is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.