exit-hook
Advanced tools
Package description
The exit-hook npm package allows developers to easily register callbacks to be executed when a Node.js process exits. This can be particularly useful for cleaning up resources, saving state, or performing other shutdown tasks in a Node.js application.
Registering a simple exit hook
This feature allows you to register a callback function that will be called when the process exits. The code sample demonstrates how to register a simple exit hook that logs a message to the console when the process exits.
const exitHook = require('exit-hook');
exitHook(() => {
console.log('Process is exiting');
});Unregistering an exit hook
This feature allows for the deregistration of an exit hook. The code sample shows how to register an exit hook and then later unregister it, preventing the callback from being called when the process exits.
const exitHook = require('exit-hook');
const unsubscribe = exitHook(() => {
console.log('Process is exiting');
});
// Later in the code, to unregister the hook
disconnect();signal-exit is a package that provides similar functionality to exit-hook, allowing you to run callbacks when a process exits. It differs in its implementation details and the breadth of exit signals it can handle, making it a good alternative depending on specific project requirements.
async-exit-hook extends the basic idea of exit-hook by adding support for asynchronous shutdown tasks. This can be particularly useful for ensuring that all asynchronous operations (e.g., database connections, file writes) are completed before the process exits.
Readme
Run some code when the process exits
The process.on('exit') event doesn't catch all the ways a process can exit.
This package is useful for cleaning up before exiting.
$ npm install exit-hook
import exitHook from 'exit-hook';
exitHook(() => {
console.log('Exiting');
});
// You can add multiple hooks, even across files
exitHook(() => {
console.log('Exiting 2');
});
throw new Error('🦄');
//=> 'Exiting'
//=> 'Exiting 2'
Removing an exit hook:
import exitHook from 'exit-hook';
const unsubscribe = exitHook(() => {});
unsubscribe();
Returns a function that removes the hook when called.
Type: Function
The callback function to execute when the process exits.
FAQs
Run some code when the process exits
The npm package exit-hook receives a total of 1,741,648 weekly downloads. As such, exit-hook popularity was classified as popular.
We found that exit-hook demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.