Nightingale Posing Mischievously
    Wondering what’s next for npm?Check out our public roadmap! »

    human-signals
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    Codecov Travis Node Gitter Twitter Medium

    Human-friendly process signals.

    This is a map of known process signals with some information about each signal.

    Unlike os.constants.signals this includes:

    Example

    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

    npm install human-signals

    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

    If you found a bug or would like a new feature, don't hesitate to submit an issue on GitHub.

    For other questions, feel free to chat with us on Gitter.

    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

    💻

    Install

    npm i human-signals

    DownloadsWeekly Downloads

    15,226,093

    Version

    2.1.0

    License

    Apache-2.0

    Unpacked Size

    44.3 kB

    Total Files

    13

    Homepage

    git.io/JeluP

    Last publish

    Collaborators

    • avatar