npmpackage.info

Gathering detailed insights and metrics for signal-exit

signal-exit

when you want to fire an event no matter how a process exits.

4.1.0

189

ISC

TypeScript

11,067,824,922 2.9

Installations

npm install signal-exit

Score

99.7

Supply Chain

91.6

Quality

78.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

63

Closed

32

Merged

29

Issues

Open

4

Total

20

Closed

16

Releases

Unable to fetch releases

Developer

tapjs

Developer Guide

BETA

Module System

CommonJS, ESM, UMD

Min. Node Version

>=14

Typescript Support

Yes

Node Version

18.16.0

NPM Version

9.7.2 Statistics

189 Stars

119 Commits

22 Forks

11 Watching

6 Branches

15 Contributors

Updated on 18 Nov 2024

Languages

TypeScript (74.85%)

JavaScript (24.53%)

Shell (0.62%)

Total Downloads

Cumulative downloads

Total Downloads

11,067,824,922

Last day

-6.5%

17,339,494

Compared to previous day

Last week

1.7%

100,591,932

Compared to previous week

Last month

10.7%

414,917,541

Compared to previous month

Last year

68.9%

3,937,117,753

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/cross-spawn @types/node @types/signal-exit @types/tap c8 prettier tap ts-node typedoc typescript

Versions

signal-exit

When you want to fire an event no matter how a process exits:

reaching the end of execution.
explicitly having process.exit(code) called.
having process.kill(pid, sig) called.
receiving a fatal signal from outside the process

Use signal-exit.

1// Hybrid module, either works
2import { onExit } from 'signal-exit'
3// or:
4// const { onExit } = require('signal-exit')
5
6onExit((code, signal) => {
7  console.log('process exited!', code, signal)
8})

API

remove = onExit((code, signal) => {}, options)

The return value of the function is a function that will remove the handler.

Note that the function only fires for signals if the signal would cause the process to exit. That is, there are no other listeners, and it is a fatal signal.

If the global process object is not suitable for this purpose (ie, it's unset, or doesn't have an emit method, etc.) then the onExit function is a no-op that returns a no-op remove method.

Options

alwaysLast: Run this handler after any other signal or exit handlers. This causes process.emit to be monkeypatched.

Capturing Signal Exits

If the handler returns an exact boolean true, and the exit is a due to signal, then the signal will be considered handled, and will not trigger a synthetic process.kill(process.pid, signal) after firing the onExit handlers.

In this case, it your responsibility as the caller to exit with a signal (for example, by calling process.kill()) if you wish to preserve the same exit status that would otherwise have occurred. If you do not, then the process will likely exit gracefully with status 0 at some point, assuming that no other terminating signal or other exit trigger occurs.

Prior to calling handlers, the onExit machinery is unloaded, so any subsequent exits or signals will not be handled, even if the signal is captured and the exit is thus prevented.

Note that numeric code exits may indicate that the process is already committed to exiting, for example due to a fatal exception or unhandled promise rejection, and so there is no way to prevent it safely.

Browser Fallback

The 'signal-exit/browser' module is the same fallback shim that just doesn't do anything, but presents the same function interface.

Patches welcome to add something that hooks onto window.onbeforeunload or similar, but it might just not be a thing that makes sense there.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

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.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

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

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/isaacs-makework.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/isaacs-makework.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/isaacs-makework.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/isaacs-makework.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/typedoc.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/typedoc.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/typedoc.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/typedoc.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/signal-exit/typedoc.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/typedoc.yml:39
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

CII-Best-Practices

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

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

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

2.9

/10

Last Scanned on 2024-11-18

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