npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jacobbubu/async-exit-hook

v1.0.0

Published

[![Build Status](https://github.com/jacobbubu/async-exit-hook/workflows/Build%20and%20Release/badge.svg)](https://github.com/jacobbubu/async-exit-hook/actions?query=workflow%3A%22Build+and+Release%22) [![Coverage Status](https://coveralls.io/repos/github/

Downloads

102

Readme

@jacobbubu/async-exit-hook

Build Status Coverage Status npm

Run some code when the process exits. async-exit-hook 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)

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.

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

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