exit-on-epipe
Advanced tools
Package description
The exit-on-epipe npm package is designed to automatically handle the 'EPIPE' error by attaching a listener to the 'process.stdout' and 'process.stderr' streams. This error typically occurs when a process writes to a stream (like stdout or stderr) but the stream has been closed, often because the output is being piped to another process which has terminated. Instead of throwing an error and potentially crashing the application, exit-on-epipe ensures the process exits gracefully.
Automatic EPIPE error handling
By simply requiring the exit-on-epipe package at the beginning of your application, it automatically handles EPIPE errors for stdout and stderr, preventing your application from crashing due to broken pipes. This is particularly useful in command-line applications that may be piped into other processes.
require('exit-on-epipe');
process.stdout.write('Hello, world!');The end-of-stream package is similar in that it helps manage stream end events, but it focuses on providing a callback when a stream or a writable has finished or failed, rather than specifically handling EPIPE errors. It's more general-purpose for stream management compared to the specific use case of exit-on-epipe.
Pump is a package that helps to safely pipe streams together, handling cleanup and errors in a more comprehensive way than exit-on-epipe. While it doesn't specifically target EPIPE errors, it provides a robust solution for managing stream pipelines and can prevent some scenarios where EPIPE might occur.
Readme
Cleanly exit on pipe errors in NodeJS scripts.
NOTE: The underlying problem was addressed in 8.x NodeJS versions but the fix was not backported to 6.x and other versions of NodeJS.
These errors are common in pipelines that involve NodeJS scripts. For example, take a simple script that prints out 10 lines:
for(var i = 0; i < 10; ++i) console.log(i)
NodeJS will print an error message if the output is truncated:
$ cat t.js
for(var i = 0; i < 10; ++i) console.log(i)
$ node --version
v6.11.1
$ node t.js | head -n 1
0
events.js:160
throw er; // Unhandled 'error' event
^
Error: write EPIPE
at exports._errnoException (util.js:1018:11)
at WriteWrap.afterWrite (net.js:800:14)
The process will cleanly exit if you require the module:
$ cat t.js
require("exit-on-epipe");
for(var i = 0; i < 10; ++i) console.log(i)
$ node t.js | head -n 1
0
With npm:
$ npm install exit-on-epipe
For basic scripts, requiring at the top of the source file suffices:
require('exit-on-epipe');
// ... rest of source
For more advanced situations (e.g. handing other streams), call the module:
var eoepipe = require('exit-on-epipe');
eoepipe(stream); // will exit process on an EPIPE error on stream
eoepipe(stream, handler); // will call handler() instead of process.exit
The module exports a single function (exposed as the variable eoepipe).
eoepipe(stream, bail) will attach an error handler to stream which will:
bail function if the error .code is "EPIPE" or .errno is 32EPIPE and if there are other error handlersIf the bail function is not specified, process.exit is used.
If the stream parameter is not specified, no action will be taken
The script will not perform any action if process or process.stdout are not
available. It is safe to use in a web page.
Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 license are reserved by the Original Author.
FAQs
Cleanly exit process on EPIPE
The npm package exit-on-epipe receives a total of 1,158,292 weekly downloads. As such, exit-on-epipe popularity was classified as popular.
We found that exit-on-epipe 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.