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:
forvar i = 0; i < 10; ++i console
NodeJS will print an error message if the output is truncated:
$ cat t.jsfor console.log$ node --versionv6.11.1$ node t.js | head -n 10events.js:160throw er; // Unhandled 'error' event^Error: write EPIPEat exports._errnoExceptionat WriteWrap.afterWrite
The process will cleanly exit if you require the module:
$ cat t.jsrequire;for console.log$ node t.js | head -n 10
$ npm install exit-on-epipe
For basic scripts, requiring at the top of the source file suffices:
;// ... rest of source
For more advanced situations (e.g. handing other streams), call the module:
var eoepipe = ;; // will exit process on an EPIPE error on stream; // will call handler() instead of process.exit
The module exports a single function (exposed as the variable
eoepipe(stream, bail) will attach an error handler to
stream which will:
- call the
bailfunction if the error
- defer to the default behavior if there are no other error handlers
- noop if the error is not
EPIPEand if there are other error handlers
bail function is not specified,
process.exit is used.
stream parameter is not specified, no action will be taken
The script will not perform any action if
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.