History

William Moore 06a625a183 Initial code commit		2024-05-14 09:54:12 -05:00
..
index.js	Initial code commit	2024-05-14 09:54:12 -05:00
package.json	Initial code commit	2024-05-14 09:54:12 -05:00
README.md	Initial code commit	2024-05-14 09:54:12 -05:00
test.js	Initial code commit	2024-05-14 09:54:12 -05:00

README.md

stream-exhaust

Ensure that the provided stream is flowing data, even if the stream hasn't been piped to another stream.

var exhaustively = require('stream-exhaust');

exhaustively(fs.createReadStream(__filename))
  .on('close', () => { console.log('all done, despite being streams{1+N}!') });

Prior Art

This is based on stream-consume by aroneous. It is a separate package because it has different semantics:

It does not call .resume() on streams2+ streams. streams2 streams monkeypatch .pipe when entering flowing mode; avoiding resume() avoids that fate.
It does not examine ._readableState; instead it checks for the presence of ._read.

API

exhaust(Stream s) -> Stream s

Takes a stream, s, and returns it. Ensures that the stream is flowing, either by calling .resume() if the stream is a streams1 stream, or by piping it to a "black hole" stream that continually asks for more data.

License

MIT