Add documentation about all being undefined

sindresorhus · Jul 4, 2019 · 27b4c25 · 27b4c25
1 parent 36a3128
commit 27b4c25
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -324,6 +324,8 @@ declare namespace execa {
 
 		/**
 		Stream combining/interleaving [`stdout`](https://nodejs.org/api/child_process.html#child_process_subprocess_stdout) and [`stderr`](https://nodejs.org/api/child_process.html#child_process_subprocess_stderr).
+
+		This is `undefined` when both `stdout` and `stderr` options are set to [`'pipe'`, `'ipc'`, `Stream` or `integer`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
 		*/
 		all?: ReadableStream;
 	}

diff --git a/readme.md b/readme.md
@@ -168,6 +168,8 @@ Type: `ReadableStream | undefined`
 
 Stream combining/interleaving [`stdout`](https://nodejs.org/api/child_process.html#child_process_subprocess_stdout) and [`stderr`](https://nodejs.org/api/child_process.html#child_process_subprocess_stderr).
 
+This is `undefined` when both [`stdout`](#stdout-1) and [`stderr`](#stderr-1) options are set to [`'pipe'`, `'ipc'`, `Stream` or `integer`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
+
 ### execa.sync(file, [arguments], [options])
 
 Execute a file synchronously.