Improve killOthers docs

Closes #535

Author: gustavohenke

README.md

@@ -96,8 +96,8 @@ Check out documentation and other usage examples in the [`docs` directory](./doc
   - `inputStream`: a [`Readable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_readable_streams)
     to read the input from. Should only be used in the rare instance you would like to stream anything other than `process.stdin`. Overrides `handleInput`.
   - `pauseInputStreamOnFinish`: by default, pauses the input stream (`process.stdin` when `handleInput` is enabled, or `inputStream` if provided) when all of the processes have finished. If you need to read from the input stream after `concurrently` has finished, set this to `false`. ([#252](https://github.com/kimmobrunfeldt/concurrently/issues/252)).
-  - `killOthers`: an array of exitting conditions that will cause a process to kill others.
-    Can contain any of `success` or `failure`.
+  - `killOthersOn`: once the first command exits with one of these statuses, kill other commands.
+    Can be an array containing the strings `success` (status code zero) and/or `failure` (non-zero exit status).
   - `maxProcesses`: how many processes should run at once.
   - `outputStream`: a [`Writable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_writable_streams)
     to write logs to. Default: `process.stdout`.

bin/concurrently.ts

@@ -112,7 +112,7 @@ const program = yargs(hideBin(process.argv))
         // Kill others
         'kill-others': {
             alias: 'k',
-            describe: 'Kill other processes if one exits or dies.',
+            describe: 'Kill other processes once the first exits.',
             type: 'boolean',
         },
         'kill-others-on-fail': {
@@ -232,7 +232,7 @@ concurrently(
     {
         handleInput: args.handleInput,
         defaultInputTarget: args.defaultInputTarget,
-        killOthers: args.killOthers
+        killOthersOn: args.killOthers
             ? ['success', 'failure']
             : args.killOthersOnFail
             ? ['failure']

src/index.ts

@@ -78,11 +78,15 @@ export type ConcurrentlyOptions = Omit<BaseConcurrentlyOptions, 'abortSignal' |
 
     // Process killing options
     /**
-     * Under which condition(s) should other commands be killed when the first one exits.
-     *
+     * @deprecated Use `killOthersOn` instead.
      * @see KillOthers
      */
     killOthers?: ProcessCloseCondition | ProcessCloseCondition[];
+    /**
+     * Once the first command exits with one of these statuses, kill other commands.
+     * @see KillOthers
+     */
+    killOthersOn?: ProcessCloseCondition | ProcessCloseCondition[];
 
     // Timing options
     /**
@@ -160,7 +164,7 @@ export function concurrently(
             }),
             new KillOthers({
                 logger,
-                conditions: options.killOthers || [],
+                conditions: options.killOthersOn || options.killOthers || [],
                 killSignal: options.killSignal,
                 abortController,
             }),