Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacobbubu/async-exit-hook
https://github.com/jacobbubu/async-exit-hook
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jacobbubu/async-exit-hook
- Owner: jacobbubu
- License: mit
- Created: 2020-09-30T03:31:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T03:43:41.000Z (over 4 years ago)
- Last Synced: 2024-12-14T09:34:54.640Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 87.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @jacobbubu/async-exit-hook
[](https://github.com/jacobbubu/async-exit-hook/actions?query=workflow%3A%22Build+and+Release%22)
[](https://coveralls.io/github/jacobbubu/async-exit-hook)
[](https://www.npmjs.com/package/@jacobbubu/async-exit-hook/)
> Run some code when the process exits.
> [async-exit-hook](https://github.com/tapppi/async-exit-hook.git) rewritten in TypeScript.
## Intro.
The `process.on('exit')` event doesn't catch all the ways a process can exit. This module catches:
* process SIGINT, SIGTERM and SIGHUP, SIGBREAK signals
* process beforeExit and exit events
* PM2 clustering process shutdown message ([PM2 graceful reload](http://pm2.keymetrics.io/docs/usage/cluster-mode/#graceful-reload))
Useful for cleaning up. You can also include async handlers, and add custom events to hook and exit on.
Forked and rewritten from [async-exit-hook](https://github.com/tapppi/async-exit-hook.git).
### Considerations and warning
#### On `process.exit()` and asynchronous code
**If you use asynchronous exit hooks, DO NOT use `process.exit()` to exit.
The `exit` event DOES NOT support asynchronous code.**
> ['beforeExit' is not emitted for conditions causing explicit termination, such as process.exit()]
(https://nodejs.org/api/process.html#process_event_beforeexit)
#### Windows and `process.kill(signal)`
On windows `process.kill(signal)` immediately kills the process, and does not fire signal events, and as such, cannot be used to gracefully exit. See *Clustering and child processes* for a workaround when killing child processes. I'm planning to support gracefully exiting with async support on windows soon.
### Clustering and child processes
If you use custom clustering / child processes, you can gracefully shutdown your child process
by sending a shutdown message (`childProc.send('shutdown')`).
### Example
```ts
import exitHook from 'async-exit-hook'
exitHook(() => {
console.log('exiting');
});
// you can add multiple hooks, even across files
exitHook(() => {
console.log('exiting 2');
});
// you can add async hooks by accepting a callback
exitHook((err, cb) => {
setTimeout(() => {
console.log('exiting 3');
cb();
}, 1000);
});
// You can hook uncaught errors with uncaughtExceptionHandler(), consequently adding
// async support to uncaught errors (normally uncaught errors result in a synchronous exit).
exitHook.uncaughtExceptionHandler(err => {
console.error(err);
});
// You can hook unhandled rejections with unhandledRejectionHandler()
exitHook.unhandledRejectionHandler(err => {
console.error(err);
});
// You can add multiple uncaught error handlers
// Add the second parameter (callback) to indicate async hooks
exitHook.uncaughtExceptionHandler((err, callback) => {
sendErrorToCloudOrWhatever(err) // Returns promise
.then(() => {
console.log('Sent err to cloud');
})
.catch(sendError => {
console.error('Error sending to cloud: ', err.stack);
})
.then(() => callback);
});
// Add exit hooks for a signal or custom message:
// Custom signal
// Arguments are `signal, exitCode` (SIGBREAK is already handled, this is an example)
exitHook.hookEvent('SIGBREAK', 21);
// process event: `message` with a filter
// filter gets all arguments passed to *handler*: `process.on(message, *handler*)`
// Exits on process event `message` with msg `customShutdownMessage` only
exitHook.hookEvent('message', 0, msg => msg !== 'customShutdownMessage');
// All async hooks will work with uncaught errors when you have specified an uncaughtExceptionHandler
throw new Error('awesome');
//=> // Sync uncaughtExcpetion hooks called and retun
//=> '[Error: awesome]'
//=> // Sync hooks called and retun
//=> 'exiting'
//=> 'exiting 2'
//=> // Async uncaughtException hooks return
//=> 'Sent error to cloud'
//=> // Sync uncaughtException hooks return
//=> 'exiting 3'
```
## License
MIT