From c5bd9d8950910bfec0d79402a29a023aae85779f Mon Sep 17 00:00:00 2001 From: ehmicky Date: Sun, 5 May 2024 11:08:44 +0100 Subject: [PATCH] Document `SIGQUIT` (#1022) --- docs/termination.md | 8 ++++++++ docs/windows.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/termination.md b/docs/termination.md index 9e09f9a41b..719b238bbb 100644 --- a/docs/termination.md +++ b/docs/termination.md @@ -87,6 +87,14 @@ process.on('SIGTERM', () => { subprocess.kill('SIGKILL'); ``` +### SIGQUIT + +[`SIGQUIT`](https://en.wikipedia.org/wiki/Signal_(IPC)#SIGQUIT) is like [`SIGTERM`](#sigterm) except it creates a [core dump](https://en.wikipedia.org/wiki/Core_dump). + +```js +subprocess.kill('SIGQUIT'); +``` + ### Other signals Other signals can be passed as argument. However, most other signals do not fully [work on Windows](https://github.com/ehmicky/cross-platform-node-guide/blob/main/docs/6_networking_ipc/signals.md#cross-platform-signals). diff --git a/docs/windows.md b/docs/windows.md index fb9f9e9f53..2ba3363fa6 100644 --- a/docs/windows.md +++ b/docs/windows.md @@ -26,7 +26,7 @@ Although Windows does not natively support shebangs, Execa adds support for them ## Signals -Only few [signals](termination.md#other-signals) work on Windows with Node.js: [`SIGTERM`](termination.md#sigterm), [`SIGKILL`](termination.md#sigkill) and [`SIGINT`](https://en.wikipedia.org/wiki/Signal_(IPC)#SIGINT). Also, sending signals from other processes is [not supported](termination.md#signal-name-and-description). Finally, the [`forceKillAfterDelay`](api.md#optionsforcekillafterdelay) option [is a noop](termination.md#forceful-termination) on Windows. +Only few [signals](termination.md#other-signals) work on Windows with Node.js: [`SIGTERM`](termination.md#sigterm), [`SIGKILL`](termination.md#sigkill), [`SIGINT`](https://en.wikipedia.org/wiki/Signal_(IPC)#SIGINT) and [`SIGQUIT`](termination.md#sigquit). Also, sending signals from other processes is [not supported](termination.md#signal-name-and-description). Finally, the [`forceKillAfterDelay`](api.md#optionsforcekillafterdelay) option [is a noop](termination.md#forceful-termination) on Windows. ## Asynchronous I/O