diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-05-02 15:21:08 +0200 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-05-02 15:21:08 +0200 |
commit | 33418bdb3349ba34ad842401e8b4c22d18cd160c (patch) | |
tree | 0c59253289cab3422d236f8633ea6cc0c5be3ca2 /lib/utils | |
parent | de47db2b666fd03b18a8478136c4414c37523063 (diff) | |
download | gitbook-33418bdb3349ba34ad842401e8b4c22d18cd160c.zip gitbook-33418bdb3349ba34ad842401e8b4c22d18cd160c.tar.gz gitbook-33418bdb3349ba34ad842401e8b4c22d18cd160c.tar.bz2 |
Document method in utils/command.js
Diffstat (limited to 'lib/utils')
-rw-r--r-- | lib/utils/command.js | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/lib/utils/command.js b/lib/utils/command.js index 7311856..90a556e 100644 --- a/lib/utils/command.js +++ b/lib/utils/command.js @@ -3,7 +3,13 @@ var childProcess = require('child_process'); var spawn = require('spawn-cmd').spawn; var Promise = require('./promise'); -// Execute a command +/** + Execute a command + + @param {String} command + @param {Object} options + @return {Promise} +*/ function exec(command, options) { var d = Promise.defer(); @@ -27,7 +33,14 @@ function exec(command, options) { return d.promise; } -// Spawn an executable +/** + Spawn an executable + + @param {String} command + @param {Array} args + @param {Object} options + @return {Promise} +*/ function spawnCmd(command, args, options) { var d = Promise.defer(); var child = spawn(command, args, options); |