Add documentation

sindresorhus · Jul 16, 2019 · fb4e785 · fb4e785
1 parent c48e2a8
commit fb4e785
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
@@ -41,6 +41,8 @@ declare namespace execa {
 		/**
 		Buffer the output from the spawned process. When buffering is disabled you must consume the output of the `stdout` and `stderr` streams because the promise will not be resolved/rejected until they have completed.
 
+		Should be set to `false` when the returned promise is not used.
+
 		If the spawned process fails, `error.stdout`, `error.stderr`, and `error.all` will contain the buffered data.
 
 		@default true

diff --git a/readme.md b/readme.md
@@ -306,6 +306,8 @@ Default: `true`
 
 Buffer the output from the spawned process. When buffering is disabled you must consume the output of the `stdout` and `stderr` streams because the promise will not be resolved/rejected until they have completed.
 
+Should be set to `false` when the returned promise is not used.
+
 If the spawned process fails, [`error.stdout`](#stdout), [`error.stderr`](#stderr), and [`error.all`](#all) will contain the buffered data.
 
 #### input