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

``js
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

`bash
npm install human-signals
`

This package works in Node.js >=18.18.0.

This is an ES module. It must be loaded using
an import or import() statement,
not require(). If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.

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.

$3

_Type_: string

Standard name of the signal, for example 'SIGINT'.

$3

_Type_: number

Code number of the signal, for example 2. While most number are
cross-platform, some are different between different OS.

$3

_Type_: string

Human-friendly description for the signal, for example
'User interruption with CTRL-C'.

$3

_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.

$3

_Type_: string\
_Enum_: 'terminate', 'core', 'ignore', 'pause', 'unpause'

What is the default action for this signal when it is not handled.

$3

_Type_: boolean

Whether the signal's default action cannot be prevented. This is true for
SIGTERM, SIGKILL and SIGSTOP.

$3

_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 💻

Felix Zedén Yverås 💻 ⚠️