From b2ddf0f9a233f8f59da748166d434217db3dfa9a Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 16 Sep 2015 14:31:42 -0700 Subject: [PATCH] doc: refine process.kill() and exit explanations Add corrections about when exit event fires and how .kill() works on Windows. PR-URL: https://github.com/nodejs/node/pull/2918 Reviewed-By: Sam Roberts --- doc/api/process.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/api/process.markdown b/doc/api/process.markdown index 960fcc2892b5d4..ee6f5404d170c8 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -59,8 +59,8 @@ finished running the process will exit. Therefore you **must** only perform checks on the module's state (like for unit tests). The callback takes one argument, the code the process is exiting with. -This event may not be fired if the process terminates due to signals like -`SIGINT`, `SIGTERM`, `SIGKILL`, and `SIGHUP`. +This event is only emitted when node exits explicitly by process.exit() or +implicitly by the event loop draining. Example of listening for `exit`: @@ -240,12 +240,12 @@ Note: - `SIGKILL` cannot have a listener installed, it will unconditionally terminate Node.js on all platforms. - `SIGSTOP` cannot have a listener installed. -- Sending `SIGINT`, `SIGTERM`, and `SIGKILL` cause the unconditional exit of the - target process. Note that Windows does not support sending Signals, but Node.js offers some emulation with `process.kill()`, and `child_process.kill()`. Sending signal `0` -can be used to test for the existence of a process +can be used to test for the existence of a process. Sending `SIGINT`, +`SIGTERM`, and `SIGKILL` cause the unconditional termination of the target +process. ## process.stdout