Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
human-signals
Advanced tools
Package description
The human-signals npm package is a library that provides human-readable descriptions and other information for system signals. It allows developers to understand and handle system signals in a more user-friendly way.
Getting human-readable information for signals
This feature allows you to retrieve information about a signal, such as its description, by using its name. The example code retrieves information about the SIGINT signal.
const { signalsByName } = require('human-signals');
const info = signalsByName['SIGINT'];
console.log(info);
Listing all signals with their information
This feature provides a list of all system signals along with their human-readable descriptions and other relevant information. The example code logs all available signals to the console.
const { signals } = require('human-signals');
console.log(signals);
The signal-exit package is used to run a callback when a process exits, including when it exits due to a signal. It is similar to human-signals in that it deals with system signals, but it focuses on executing callbacks rather than providing human-readable information.
The os-signals package is another library that can be used to handle system signals. It provides a way to listen for signals and execute callbacks. While it also deals with system signals, it does not provide the human-readable descriptions that human-signals does.
Readme
Human-friendly process signals.
This is a map of known process signals with some information about each signal.
Unlike
os.constants.signals
this includes:
import { signalsByName, signalsByNumber } from 'human-signals'
console.log(signalsByName.SIGINT)
// {
// name: 'SIGINT',
// number: 2,
// description: 'User interruption with CTRL-C',
// supported: true,
// action: 'terminate',
// forced: false,
// standard: 'ansi'
// }
console.log(signalsByNumber[8])
// {
// name: 'SIGFPE',
// number: 8,
// description: 'Floating point arithmetic error',
// supported: true,
// action: 'core',
// forced: false,
// standard: 'ansi'
// }
npm install human-signals
This package works in Node.js >=14.18.0. It is an ES module and must be loaded
using
an import
or import()
statement,
not require()
.
Type: object
Object whose keys are signal names and values are signal objects.
Type: object
Object whose keys are signal numbers and values are signal objects.
Type: object
Signal object with the following properties.
Type: string
Standard name of the signal, for example 'SIGINT'
.
Type: number
Code number of the signal, for example 2
. While most number
are
cross-platform, some are different between different OS.
Type: string
Human-friendly description for the signal, for example
'User interruption with CTRL-C'
.
Type: boolean
Whether the current OS can handle this signal in Node.js using
process.on(name, handler)
.
The list of supported signals is OS-specific.
Type: string
Enum: 'terminate'
, 'core'
, 'ignore'
, 'pause'
, 'unpause'
What is the default action for this signal when it is not handled.
Type: boolean
Whether the signal's default action cannot be prevented. This is true
for
SIGTERM
, SIGKILL
and SIGSTOP
.
Type: string
Enum: 'ansi'
, 'posix'
, 'bsd'
, 'systemv'
, 'other'
Which standard defined that signal.
For any question, don't hesitate to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
Thanks go to our wonderful contributors:
ehmicky 💻 🎨 🤔 📖 | electrovir 💻 |
FAQs
Human-friendly process signals
The npm package human-signals receives a total of 48,790,466 weekly downloads. As such, human-signals popularity was classified as popular.
We found that human-signals 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
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.