Gathering detailed insights and metrics for @jacobbubu/async-exit-hook
Gathering detailed insights and metrics for @jacobbubu/async-exit-hook
Installations
npm install @jacobbubu/async-exit-hookDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=10.0.0
Node Version
12.18.4
NPM Version
6.14.6
Languages
2
TypeScript
JavaScript
TypeScript (98.66%)
JavaScript (1.34%)
Developer
jacobbubu
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
1 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Sep 30, 2020
Maintainers
1
Package Meta Information
Latest Version
1.0.0
Package Id
@jacobbubu/async-exit-hook@1.0.0
Unpacked Size
17.00 kB
Size
6.13 kB
File Count
6
NPM Version
6.14.6
Node Version
12.18.4
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
30
@types/jest@types/node@types/rc@types/shelljscolorscommitizencoverallscross-envcz-conventional-changelogenquirerhuskyis-scopedjestlint-stagedlodash.camelcasenpm-nameprettierpromptreplace-in-filerimrafshelljsts-jestts-nodets-node-devtslinttslint-config-prettiertslint-config-standardtypescriptvalidate-commit-msgvalidate-npm-package-name
@jacobbubu/async-exit-hook
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
1import exitHook from '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((err, cb) => { 14 setTimeout(() => { 15 console.log('exiting 3'); 16 cb(); 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// Add exit hooks for a signal or custom message: 45 46// Custom signal 47// Arguments are `signal, exitCode` (SIGBREAK is already handled, this is an example) 48exitHook.hookEvent('SIGBREAK', 21); 49 50// process event: `message` with a filter 51// filter gets all arguments passed to *handler*: `process.on(message, *handler*)` 52// Exits on process event `message` with msg `customShutdownMessage` only 53exitHook.hookEvent('message', 0, msg => msg !== 'customShutdownMessage'); 54 55// All async hooks will work with uncaught errors when you have specified an uncaughtExceptionHandler 56throw new Error('awesome'); 57 58//=> // Sync uncaughtExcpetion hooks called and retun 59//=> '[Error: awesome]' 60//=> // Sync hooks called and retun 61//=> 'exiting' 62//=> 'exiting 2' 63//=> // Async uncaughtException hooks return 64//=> 'Sent error to cloud' 65//=> // Sync uncaughtException hooks return 66//=> 'exiting 3'
License
MIT
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-release.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-release.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/build-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-pull-request.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/check-pull-request.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-pull-request.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/check-pull-request.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-pull-request.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/jacobbubu/async-exit-hook/check-pull-request.yml/master?enable=pin
- Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
Found 0/1 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/check-pull-request.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
42 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-x55w-vjjp-222r
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- 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-7wpw-2hjm-89gp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
2.8
/10
Last Scanned on 2025-07-07
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