diff options
Diffstat (limited to 'node_modules/signal-exit/README.md')
| -rw-r--r-- | node_modules/signal-exit/README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/signal-exit/README.md b/node_modules/signal-exit/README.md new file mode 100644 index 0000000..8ebccab --- /dev/null +++ b/node_modules/signal-exit/README.md @@ -0,0 +1,40 @@ +# signal-exit + +[](https://travis-ci.org/tapjs/signal-exit) +[](https://coveralls.io/r/tapjs/signal-exit?branch=master) +[](https://www.npmjs.com/package/signal-exit) +[](https://ci.appveyor.com/project/bcoe/signal-exit) +[](https://github.com/conventional-changelog/standard-version) + +When you want to fire an event no matter how a process exits: + +* reaching the end of execution. +* explicitly having `process.exit(code)` called. +* having `process.kill(pid, sig)` called. +* receiving a fatal signal from outside the process + +Use `signal-exit`. + +```js +var onExit = require('signal-exit') + +onExit(function (code, signal) { + console.log('process exited!') +}) +``` + +## API + +`var remove = onExit(function (code, signal) {}, options)` + +The return value of the function is a function that will remove the +handler. + +Note that the function *only* fires for signals if the signal would +cause the proces to exit. That is, there are no other listeners, and +it is a fatal signal. + +## Options + +* `alwaysLast`: Run this handler after any other signal or exit + handlers. This causes `process.emit` to be monkeypatched. |