end-of-stream
Advanced tools
Package description
The end-of-stream npm package is designed to help developers handle the end or error conditions of a stream more easily. It provides a simple way to execute a callback when a stream has finished or failed, making it easier to manage streams in Node.js applications.
Callback on stream end
This feature allows you to execute a callback function when the stream ends or encounters an error. The code sample demonstrates how to use end-of-stream with a file read stream.
const eos = require('end-of-stream');
const fs = require('fs');
const readStream = fs.createReadStream('file.txt');
eos(readStream, function(err) {
if (err) return console.log('Stream had an error or closed early');
console.log('Stream has ended');
});Promise support
This feature demonstrates how to use end-of-stream with promises, providing a more modern approach to handling stream completion. It uses the `promisify` utility from Node.js to convert the eos callback pattern into a promise.
const eos = require('end-of-stream');
const fs = require('fs');
const { promisify } = require('util');
const eosPromise = promisify(eos);
const readStream = fs.createReadStream('file.txt');
eosPromise(readStream).then(() => console.log('Stream has ended')).catch(err => console.log('Stream had an error or closed early'));Similar to end-of-stream, stream-ended is a package that provides functionality to detect when a stream has ended. It differs in its implementation and API but serves a similar purpose of stream end detection.
Pump is a package that not only listens for the end of streams but also helps to pipe streams together and handles cleanup in case of a stream ending prematurely. It's more comprehensive than end-of-stream as it also manages the flow between streams.
Readme
A node module that calls a callback when a readable/writable/duplex stream has completed or failed.
npm install end-of-stream
Simply pass a stream and a callback to the eos.
Both legacy streams, streams2 and stream3 are supported.
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', this === readableStream);
});
eos(writableStream, function(err) {
if (err) return console.log('stream had an error or closed early');
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', this === duplexStream);
});
eos(duplexStream, {readable:false}, function(err) {
if (err) return console.log('stream had an error or closed early');
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 writable');
});
eos(readableStream, {error:false}, function(err) {
// do not treat emit('error', err) as a end-of-stream
});
MIT
end-of-stream is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.
FAQs
Call a callback when a readable/writable/duplex stream has completed or failed.
The npm package end-of-stream receives a total of 20,676,422 weekly downloads. As such, end-of-stream popularity was classified as popular.
We found that end-of-stream demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.