Company News
Connect with Socket at RSA and BSidesSF 2024
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.
By Sarah Gooding - Apr 15, 2024
human-signals
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 57,365,752
- decreased by-0.78%
Weekly downloads
Package description
What is human-signals?
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.
What are human-signals's main functionalities?
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);Other packages similar to human-signals
signal-exit
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.
os-signals
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:
- human-friendly descriptions
- default actions, including whether they can be prevented
- whether the signal is supported by the current OS
Example
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'
// }
Install
npm install human-signals
This package is an ES module and must be loaded using
an import or import() statement,
not require().
Usage
signalsByName
Type: object
Object whose keys are signal names and values are signal objects.
signalsByNumber
Type: object
Object whose keys are signal numbers and values are signal objects.
signal
Type: object
Signal object with the following properties.
name
Type: string
Standard name of the signal, for example 'SIGINT'.
number
Type: number
Code number of the signal, for example 2. While most number are
cross-platform, some are different between different OS.
description
Type: string
Human-friendly description for the signal, for example
'User interruption with CTRL-C'.
supported
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.
action
Type: string
Enum: 'terminate', 'core', 'ignore', 'pause', 'unpause'
What is the default action for this signal when it is not handled.
forced
Type: boolean
Whether the signal's default action cannot be prevented. This is true for
SIGTERM, SIGKILL and SIGSTOP.
standard
Type: string
Enum: 'ansi', 'posix', 'bsd', 'systemv', 'other'
Which standard defined that signal.
Support
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.
Contributing
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 46,648,885 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.
Last updated on 26 Jun 2022
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.
Related posts
Security News
OSI to Lead Discussions on Navigating the Challenges of Doing Business with Open Source
OSI is starting a conversation aimed at removing the excuse of the SaaS loophole for companies navigating licensing and the complexities of doing business with open source.
By Sarah Gooding - Apr 12, 2024
Product
Introducing Dependency Visualization: An Interactive Way to See Dependencies at a Glance
We're introducing dependency visualization for reports - get a quick impression of the state of your dependencies without getting lost in the details.
By Eli Insua - Apr 11, 2024