156 lines
4.6 KiB
Markdown
156 lines
4.6 KiB
Markdown
[](https://codecov.io/gh/ehmicky/human-signals)
|
|
[](https://travis-ci.org/ehmicky/human-signals)
|
|
[](https://www.npmjs.com/package/human-signals)
|
|
[](https://gitter.im/ehmicky/human-signals)
|
|
[](https://twitter.com/intent/follow?screen_name=ehmicky)
|
|
[](https://medium.com/@ehmicky)
|
|
|
|
Human-friendly process signals.
|
|
|
|
This is a map of known process signals with some information about each signal.
|
|
|
|
Unlike
|
|
[`os.constants.signals`](https://nodejs.org/api/os.html#os_signal_constants)
|
|
this includes:
|
|
|
|
- human-friendly [descriptions](#description)
|
|
- [default actions](#action), including whether they [can be prevented](#forced)
|
|
- whether the signal is [supported](#supported) by the current OS
|
|
|
|
# Example
|
|
|
|
```js
|
|
const { signalsByName, signalsByNumber } = require('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
|
|
```
|
|
|
|
# Usage
|
|
|
|
## signalsByName
|
|
|
|
_Type_: `object`
|
|
|
|
Object whose keys are signal [names](#name) and values are
|
|
[signal objects](#signal).
|
|
|
|
## signalsByNumber
|
|
|
|
_Type_: `object`
|
|
|
|
Object whose keys are signal [numbers](#number) and values are
|
|
[signal objects](#signal).
|
|
|
|
## 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)`](https://nodejs.org/api/process.html#process_signal_events).
|
|
|
|
The list of supported signals
|
|
[is OS-specific](https://github.com/ehmicky/cross-platform-node-guide/blob/master/docs/6_networking_ipc/signals.md#cross-platform-signals).
|
|
|
|
### action
|
|
|
|
_Type_: `string`<br>_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`<br>_Enum_: `'ansi'`, `'posix'`, `'bsd'`, `'systemv'`, `'other'`
|
|
|
|
Which standard defined that signal.
|
|
|
|
# Support
|
|
|
|
If you found a bug or would like a new feature, _don't hesitate_ to
|
|
[submit an issue on GitHub](../../issues).
|
|
|
|
For other questions, feel free to
|
|
[chat with us on Gitter](https://gitter.im/ehmicky/human-signals).
|
|
|
|
Everyone is welcome regardless of personal background. We enforce a
|
|
[Code of conduct](CODE_OF_CONDUCT.md) 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](CONTRIBUTING.md). Pull requests are welcome!
|
|
|
|
<!-- Thanks go to our wonderful contributors: -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START -->
|
|
<!-- prettier-ignore -->
|
|
<table><tr><td align="center"><a href="https://twitter.com/ehmicky"><img src="https://avatars2.githubusercontent.com/u/8136211?v=4" width="100px;" alt="ehmicky"/><br /><sub><b>ehmicky</b></sub></a><br /><a href="https://github.com/ehmicky/human-signals/commits?author=ehmicky" title="Code">💻</a> <a href="#design-ehmicky" title="Design">🎨</a> <a href="#ideas-ehmicky" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ehmicky/human-signals/commits?author=ehmicky" title="Documentation">📖</a></td></tr></table>
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|