feat(runtime): make kill signal optional (denoland#16299)

This commit changes "Deno.kill()" method to have a default value, that is "SIGTERM".
DavidDeSimone · Oct 26, 2022 · 6ac603e · 6ac603e
1 parent 642118f
commit 6ac603e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/cli/dts/lib.deno.ns.d.ts b/cli/dts/lib.deno.ns.d.ts
@@ -3439,18 +3439,19 @@ declare namespace Deno {
     /** Clean up resources associated with the sub-process instance. */
     close(): void;
     /** Send a signal to process.
+     * Default signal is `"SIGTERM"`.
      *
      * ```ts
      * const p = Deno.run({ cmd: [ "sleep", "20" ]});
      * p.kill("SIGTERM");
      * p.close();
      * ```
      */
-    kill(signo: Signal): void;
+    kill(signo?: Signal): void;
   }
 
   /** Operating signals which can be listened for or sent to sub-processes. What
-   * signals and what their standard behaviors are are OS dependent.
+   * signals and what their standard behaviors are OS dependent.
    *
    * @category Runtime Environment */
   export type Signal =
@@ -4471,7 +4472,8 @@ declare namespace Deno {
 
   /** Send a signal to process under given `pid`. The value and meaning of the
    * `signal` to the process is operating system and process dependant.
-   * {@linkcode Signal} provides the most common signals.
+   * {@linkcode Signal} provides the most common signals. Default signal
+   * is `"SIGTERM"`.
    *
    * The term `kill` is adopted from the UNIX-like command line command `kill`
    * which also signals processes.
@@ -4493,7 +4495,7 @@ declare namespace Deno {
    * @tags allow-run
    * @category Sub Process
    */
-  export function kill(pid: number, signal: Signal): void;
+  export function kill(pid: number, signo?: Signal): void;
 
   /** The type of the resource record to resolve via DNS using
    * {@linkcode Deno.resolveDns}.

diff --git a/runtime/js/40_process.js b/runtime/js/40_process.js
@@ -20,7 +20,7 @@
     ops.op_kill(pid, signo, apiName);
   }
 
-  function kill(pid, signo) {
+  function kill(pid, signo = "SIGTERM") {
     opKill(pid, signo, "Deno.kill()");
   }
 
@@ -94,7 +94,7 @@
       core.close(this.rid);
     }
 
-    kill(signo) {
+    kill(signo = "SIGTERM") {
       opKill(this.pid, signo, "Deno.Process.kill()");
     }
   }