npmpackage.info

Gathering detailed insights and metrics for async-exit-hook

Other packages similar to async-exit-hook

exit-hook

4.0.0

Run some code when the process exits

@types/async-exit-hook

2.0.2

TypeScript definitions for async-exit-hook

log-update-async-hook

2.0.7

log-update fork that uses async-exit-hook internally

async-exit-hook-improved

2.0.3

Run some code when the process exits (supports async hooks and pm2 clustering)

Gathering detailed insights and metrics for async-exit-hook

async-exit-hook - 2.0.1 | npmpackage.info

async-exit-hook

Run some code when the process exits

2.0.1

118

MIT

JavaScript

1.9

Installations

npm install async-exit-hook

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>=0.12.0

Node Version

6.11.2

NPM Version

5.3.0 Pull Requests

Open

2

Total

7

Closed

1

Merged

4

Issues

Open

8

Total

9

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

tapppi

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

118 Stars

80 Commits

15 Forks

4 Watchers

6 Branches

1 Contributors

Updated on Jun 13, 2024

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

2.0.1

Package Id

async-exit-hook@2.0.1

Size

4.55 kB

NPM Version

5.3.0

Node Version

6.11.2

Published on

Aug 03, 2017

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

ava coveralls nyc standard-version xo

async-exit-hook

Run some code when the process exits

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 pretty much rewritten from exit-hook.

Install

$ npm install --save async-exit-hook

Usage

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

1const exitHook = require('async-exit-hook');
2
3exitHook(() => {
4    console.log('exiting');
5});
6
7// you can add multiple hooks, even across files
8exitHook(() => {
9    console.log('exiting 2');
10});
11
12// you can add async hooks by accepting a callback
13exitHook(callback => {
14    setTimeout(() => {
15        console.log('exiting 3');
16        callback();
17    }, 1000);
18});
19
20// You can hook uncaught errors with uncaughtExceptionHandler(), consequently adding 
21// async support to uncaught errors (normally uncaught errors result in a synchronous exit).
22exitHook.uncaughtExceptionHandler(err => {
23    console.error(err);
24});
25
26// You can hook unhandled rejections with unhandledRejectionHandler()
27exitHook.unhandledRejectionHandler(err => {
28    console.error(err);
29});
30
31// You can add multiple uncaught error handlers
32// Add the second parameter (callback) to indicate async hooks
33exitHook.uncaughtExceptionHandler((err, callback) => {
34    sendErrorToCloudOrWhatever(err) // Returns promise
35        .then(() => { 
36             console.log('Sent err to cloud'); 
37         });
38        .catch(sendError => {
39             console.error('Error sending to cloud: ', err.stack));
40        })
41        .then(() => callback);
42    });
43});
44
45// Add exit hooks for a signal or custom message:
46
47// Custom signal
48// Arguments are `signal, exitCode` (SIGBREAK is already handled, this is an example)
49exitHook.hookEvent('SIGBREAK', 21);
50
51// process event: `message` with a filter
52// filter gets all arguments passed to *handler*: `process.on(message, *handler*)`
53// Exits on process event `message` with msg `customShutdownMessage` only
54exitHook.hookEvent('message', 0, msg => msg !== 'customShutdownMessage');
55
56// All async hooks will work with uncaught errors when you have specified an uncaughtExceptionHandler
57throw new Error('awesome');
58
59//=> // Sync uncaughtExcpetion hooks called and retun
60//=> '[Error: awesome]'
61//=> // Sync hooks called and retun
62//=> 'exiting'
63//=> 'exiting 2'
64//=> // Async uncaughtException hooks return
65//=> 'Sent error to cloud'
66//=> // Sync uncaughtException hooks return
67//=> 'exiting 3'

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

77 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-p9w8-2mpq-49h9
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-2m96-9w4j-wgv7
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.9

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to async-exit-hook

Other packages similar to async-exit-hook

async-exit-hook

Installations

Developer Guide

No

N/A

>=0.12.0

6.11.2

5.3.0

Pull Requests

2

7

1

4

Issues

8

9

1

Releases

Unable to fetch releases

Languages

Developer

tapppi

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

async-exit-hook

Install

Usage

Considerations and warning

On process.exit() and asynchronous code

Windows and process.kill(signal)

Clustering and child processes

Example

License

10

10

1

0

0

0

0

0

0

0

1.9

/10

On `process.exit()` and asynchronous code

Windows and `process.kill(signal)`