@queuehammer/signal v1.0.0

Signal

TLDR;

Use standard handlers to respond to the multitude of system signals.

new Signal({
  // Shutdown express, and it's about time, literally.
  // We were just signaled
  onTerm: () => expressApp.close()
});

Three callbacks are provided (Maybe more in the future); onTerm, onCore, and onIgn. This gives you a little more control over how they are handled. Stop and Continue are caught by Node.js, so they are not provided.

Suggestions on how you can try to handel these errors come from the signal(7) man page... | Category | General Response | |--|--| | Term | Default action is to terminate the process. | | Ign | Default action is to ignore the signal. | | Core | Default action is to terminate the process and dump core (see core(5)). |

Slightly More Copy

Things happen, systems send signals to your app, and whether or not your listening to them they expect things to happen. Sometimes this means letting you stop something you started gracefully. It could be you just want it to shutdown faster when the time comes. So your not waiting for your Docker containers for the full timeout every time. It's only 10 seconds, but imagine that hundreds of times. The standard signals have standard responses and this library lets you set a callback for the ones we can handle.

Caviots in Node

• SIGUSR1 is reserved by Node.js to start the debugger. They say this causes problems so it's ignored
• SIGTERM and SIGINT have default handlers, but i've noticed they dont seem to stop express, so you should use the Term handler to do that or kill other processes you have started. Once you do... you still need to shutdown the app like the original handler would. Maybe not a surprise here, this library does that for you.
• SIGHUP is SIGTERM for Windows.
• SIGTERM is not supported on Windows, it can be listened on, so it gets another footnote.
• SIGBREAK not in the original POSIX set, cause windows, but is delivered on Windows when + is pressed, on non-Windows platforms it can be listened on, but there is no way to send or generate it. A listener is created, and it's grouped under the Ign handler.
• SIGWINCH also no in the original POSIX is delivered when the console has been resized. On Windows, this will only happen on write to the console when the cursor is being moved, or when a readable tty is used in raw mode.
• SIGKILL Adding a listener will cause a runtime error in newer version of Node.js so this library does not do that.
• SIGSTOP like SIGKILL.
• SIGBUS, SIGFPE, SIGSEGV and SIGILL, when not raised artificially using kill(2), inherently leave the process in a state from which it is not safe to attempt to call JS listeners. Doing so might lead to the process hanging in an endless loop, since listeners attached using process.on() are called asynchronously and therefore unable to correct the underlying problem.

Signal - Overview of Signals

Good additional reading on the signals that exist, just not the windows ones.