Document stdout and stderr arguments to callback in usage example

This commit is contained in:
Joran Dirk Greef 2015-11-26 12:12:30 +02:00
parent f91a0a9b16
commit f163c812cd

View file

@ -22,7 +22,7 @@ var options = {
icns: '/path/to/icns/file', // (optional) icns: '/path/to/icns/file', // (optional)
onChildProcess: function(childProcess) {} // (optional) onChildProcess: function(childProcess) {} // (optional)
}; };
sudo.exec('echo hello', options, function(error) {}); sudo.exec('echo hello', options, function(error, stdout, stderr) {});
``` ```
`sudo-prompt` will use `process.title` as `options.name` if `options.name` is not provided. `options.name` must be alphanumeric only (spaces are supported) and at most 70 characters. `sudo-prompt` will use `process.title` as `options.name` if `options.name` is not provided. `options.name` must be alphanumeric only (spaces are supported) and at most 70 characters.