https://github.com/troygoode/node-diehard
Gracefully clean up your program at termination with multiple sync and/or async handlers. Wraps the `death` npm module.
https://github.com/troygoode/node-diehard
Last synced: about 1 month ago
JSON representation
Gracefully clean up your program at termination with multiple sync and/or async handlers. Wraps the `death` npm module.
- Host: GitHub
- URL: https://github.com/troygoode/node-diehard
- Owner: troygoode
- License: mit
- Created: 2013-11-04T01:20:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-04T04:48:47.000Z (over 6 years ago)
- Last Synced: 2025-04-15T02:07:26.382Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://github.com/troygoode/node-diehard
- Size: 21.5 KB
- Stars: 16
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `diehard`
Diehard is a node.js module that helps you gracefully clean up your program at termination with multiple sync and/or async handlers. Wraps the [`death`](https://github.com/jprichardson/node-death) npm module.
[](https://nodei.co/npm/diehard/)
# Why?
[`death`](https://github.com/jprichardson/node-death) is an incredibly useful module that abstracts out the need to handle the various kinds of termination events, but ultimately only supports a single handler. I've found that in more complex projects you often have multiple loose ends to clean up, and I desired a solution that would allow me to properly isolate the responsibility for cleaning up each individual resource into dedicated handlers that would are run in parallel. `diehard` solves that problem.
## Installation (via [npm](https://npmjs.org/package/diehard))
```bash
$ npm install diehard
```
# Usage
```javascript
var diehard = require('diehard');
setInterval(function () {
console.log('Blah blah blah.'); // keeps running until we CTRL+C
}, 250);
diehard.register(function () {
//TODO: clean up some resource
// this is a synchronous handler
});
diehard.register(function (done) {
//TODO: clean up some resource
done(); // async, ftw!
});
diehard.register(function (signal, done) {
//TODO: clean up some resource
// we also have the `signal` that terminated the process here, in case we care
done();
});
diehard.register(function (signal, uncaughtErr, done) {
//TODO: clean up some resource
// if an uncaught error was the reason the process is terminating, we can access that, too
done();
});
diehard.listen();
```
In the above example, all five termination handlers will be run (in parallel) before the process exits.
## License
[MIT License](http://www.opensource.org/licenses/mit-license.php)
## Author
[Troy Goode](https://github.com/TroyGoode) ([[email protected]](mailto:[email protected]))