Initial commit
This commit is contained in:
+13
@@ -0,0 +1,13 @@
|
||||
Copyright (C) 2015-present SheetJS
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
# exit-on-epipe
|
||||
|
||||
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:
|
||||
|
||||
```js
|
||||
for(var i = 0; i < 10; ++i) console.log(i)
|
||||
```
|
||||
|
||||
NodeJS will print an error message if the output is truncated:
|
||||
|
||||
```bash
|
||||
$ 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:
|
||||
|
||||
```bash
|
||||
$ cat t.js
|
||||
require("exit-on-epipe");
|
||||
for(var i = 0; i < 10; ++i) console.log(i)
|
||||
$ node t.js | head -n 1
|
||||
0
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
With [npm](https://www.npmjs.org/package/exit-on-epipe):
|
||||
|
||||
```bash
|
||||
$ npm install exit-on-epipe
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
For basic scripts, requiring at the top of the source file suffices:
|
||||
|
||||
```js
|
||||
require('exit-on-epipe');
|
||||
// ... rest of source
|
||||
```
|
||||
|
||||
For more advanced situations (e.g. handing other streams), call the module:
|
||||
|
||||
```js
|
||||
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
|
||||
```
|
||||
|
||||
## Interface
|
||||
|
||||
The module exports a single function (exposed as the variable `eoepipe`).
|
||||
|
||||
`eoepipe(stream, bail)` will attach an error handler to `stream` which will:
|
||||
|
||||
- call the `bail` function if the error `.code` is `"EPIPE"` or `.errno` is `32`
|
||||
- defer to the default behavior if there are no other error handlers
|
||||
- noop if the error is not `EPIPE` and if there are other error handlers
|
||||
|
||||
If the `bail` function is not specified, `process.exit` is used.
|
||||
|
||||
If the `stream` parameter is not specified, no action will be taken
|
||||
|
||||
## Notes
|
||||
|
||||
The script will not perform any action if `process` or `process.stdout` are not
|
||||
available. It is safe to use in a web page.
|
||||
|
||||
## License
|
||||
|
||||
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.
|
||||
|
||||
## Badges
|
||||
|
||||
[](https://travis-ci.org/SheetJS/node-exit-on-epipe)
|
||||
|
||||
[](https://npmjs.org/package/exit-on-epipe)
|
||||
|
||||
[](https://npmjs.org/package/exit-on-epipe)
|
||||
|
||||
[](https://david-dm.org/sheetjs/node-exit-on-epipe)
|
||||
|
||||
[](https://ghit.me/repo/sheetjs/node-exit-on-epipe)
|
||||
|
||||
[](https://github.com/SheetJS/node-exit-on-epipe)
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
/* exit-on-epipe.js (C) 2015-present SheetJS -- http://sheetjs.com */
|
||||
/* vim: set ts=2: */
|
||||
/*jshint eqnull:true, node:true */
|
||||
var eoepipe = function eoepipeit(S/*:events$EventEmitter*/, bail/*:?()=>any*/) {
|
||||
if(!S || !S.on) return;
|
||||
if(!bail && typeof process !== 'undefined') bail = process.exit;
|
||||
var eoe = function eoeit(err/*:ErrnoError*/) {
|
||||
if(err.code === 'EPIPE' || err.errno === /*EPIPE*/32) { if(bail) bail(); else return; }
|
||||
var cnt = S.listenerCount ? S.listenerCount('error') : S.listeners('error').length;
|
||||
if(cnt == 1) {
|
||||
S.removeListener('error', eoe);
|
||||
S.emit('error', err);
|
||||
S.on('error', eoe);
|
||||
}
|
||||
};
|
||||
S.on('error', eoe);
|
||||
};
|
||||
|
||||
if(typeof module !== 'undefined') module.exports = eoepipe;
|
||||
if(typeof process !== 'undefined') eoepipe(process.stdout);
|
||||
+64
@@ -0,0 +1,64 @@
|
||||
{
|
||||
"_from": "exit-on-epipe@~1.0.1",
|
||||
"_id": "[email protected]",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-h2z5mrROTxce56S+pnvAV890uu7ls7f1kEvVGJbw1OlFH3/mlJ5bkXu0KRyW94v37zzHPiUd55iLn3DA7TjWpw==",
|
||||
"_location": "/exit-on-epipe",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "exit-on-epipe@~1.0.1",
|
||||
"name": "exit-on-epipe",
|
||||
"escapedName": "exit-on-epipe",
|
||||
"rawSpec": "~1.0.1",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "~1.0.1"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/crc-32"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/exit-on-epipe/-/exit-on-epipe-1.0.1.tgz",
|
||||
"_shasum": "0bdd92e87d5285d267daa8171d0eb06159689692",
|
||||
"_spec": "exit-on-epipe@~1.0.1",
|
||||
"_where": "/Users/talksik/Development/nirvana-server/node_modules/crc-32",
|
||||
"author": {
|
||||
"name": "sheetjs"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/SheetJS/node-exit-on-epipe/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {},
|
||||
"deprecated": false,
|
||||
"description": "Cleanly exit process on EPIPE",
|
||||
"devDependencies": {
|
||||
"mocha": "~2.5.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.8"
|
||||
},
|
||||
"files": [
|
||||
"exit-on-epipe.js",
|
||||
"LICENSE",
|
||||
"README.md"
|
||||
],
|
||||
"homepage": "https://github.com/SheetJS/node-exit-on-epipe#readme",
|
||||
"keywords": [
|
||||
"epipe",
|
||||
"pipe",
|
||||
"error",
|
||||
"exit"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"main": "./exit-on-epipe",
|
||||
"name": "exit-on-epipe",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/SheetJS/node-exit-on-epipe.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "make test"
|
||||
},
|
||||
"version": "1.0.1"
|
||||
}
|
||||
Reference in New Issue
Block a user