|
|
# signal-exit
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// Hybrid module, either worksimport { onExit } from 'signal-exit'// or:// const { onExit } = require('signal-exit')
onExit((code, signal) => { console.log('process exited!', code, signal)})```
## API
`remove = onExit((code, signal) => {}, options)`
The return value of the function is a function that will removethe handler.
Note that the function _only_ fires for signals if the signalwould cause the process to exit. That is, there are no otherlisteners, and it is a fatal signal.
If the global `process` object is not suitable for this purpose(ie, it's unset, or doesn't have an `emit` method, etc.) then the`onExit` function is a no-op that returns a no-op `remove` method.
### Options
- `alwaysLast`: Run this handler after any other signal or exit handlers. This causes `process.emit` to be monkeypatched.
### Capturing Signal Exits
If the handler returns an exact boolean `true`, and the exit is adue to signal, then the signal will be considered handled, andwill _not_ trigger a synthetic `process.kill(process.pid,signal)` after firing the `onExit` handlers.
In this case, it your responsibility as the caller to exit with asignal (for example, by calling `process.kill()`) if you wish topreserve the same exit status that would otherwise have occurred.If you do not, then the process will likely exit gracefully withstatus 0 at some point, assuming that no other terminating signalor other exit trigger occurs.
Prior to calling handlers, the `onExit` machinery is unloaded, soany subsequent exits or signals will not be handled, even if thesignal is captured and the exit is thus prevented.
Note that numeric code exits may indicate that the process isalready committed to exiting, for example due to a fatalexception or unhandled promise rejection, and so there is no way toprevent it safely.
### Browser Fallback
The `'signal-exit/browser'` module is the same fallback shim thatjust doesn't do anything, but presents the same functioninterface.
Patches welcome to add something that hooks onto`window.onbeforeunload` or similar, but it might just not be athing that makes sense there.
|