archive-gh-me/shelljs
1
0
Fork 0
mirror of https://github.com/shelljs/shelljs.git synced 2026-01-18 16:03:37 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #289 from vise890/master

Browse Source 
update `exec` docs to match implemented behaviour
This commit is contained in:
Nate Fischer 2016-01-14 10:14:33 -08:00
commit 439a0b0aaa
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -475,7 +475,8 @@ Object containing environment variables (both getter and setter). Shortcut to pr
### exec(command [, options] [, callback])
Available options (all `false` by default):
+ `async`: Asynchronous execution. Defaults to true if a callback is provided.
+ `async`: Asynchronous execution. If a callback is provided, it will be set to
`true`, regardless of the passed value.
+ `silent`: Do not echo program output to console.
Examples:

3
src/exec.js
View File

@ -182,7 +182,8 @@ function execAsync(cmd, opts, callback) {
//@ ### exec(command [, options] [, callback])
//@ Available options (all `false` by default):
//@
//@ + `async`: Asynchronous execution. Defaults to true if a callback is provided.
//@ + `async`: Asynchronous execution. If a callback is provided, it will be set to
//@ `true`, regardless of the passed value.
//@ + `silent`: Do not echo program output to console.
//@
//@ Examples: