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.

What are end-of-stream's main functionalities?

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'));

Other packages similar to end-of-stream

Readme

Source

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 and streams2 are supported.

var eos = require('end-of-stream');

eos(readableStream, function(err) {
	if (err) return console.log('stream had an error or closed early');
	console.log('stream has ended');
});

eos(writableStream, function(err) {
	if (err) return console.log('stream had an error or closed early');
	console.log('stream has finished');
});

eos(duplexStream, function(err) {
	if (err) return console.log('stream had an error or closed early');
	console.log('stream has ended and finished');
});

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');
});

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');
});

eos(readableStream, {error:false}, function(err) {
	// do not treat emit('error', err) as a end-of-stream
});

License

MIT

Keywords

FAQs

What is end-of-stream?

Is end-of-stream popular?

Is end-of-stream well maintained?

Last updated on 21 Jul 2014

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.

Install