buffered-spawn
v3.3.2
Published
Buffered child process#spawn.
Downloads
78,755
Readme
buffered-spawn
Buffered child_process#spawn.
Installation
$ npm install buffered-spawn
Why
- Easy to use
- Uses cross-spawn by default, which fixes windows issues
- Supports callback & promise style
Usage
In terms of arguments, they are equal to node's spawn.
const bufferedSpawn = require('buffered-spawn');
// Callback style
bufferedSpawn('git', ['clone', '[email protected]/bower/bower'], { cwd: '.' }, (err, stdout, stderr) => {
if (err) {
// Both stdout and stderr are also set on the error object
return console.error(`Command failed with error code of #${err.status}`);
}
console.log(stdout);
console.log(stderr);
});
// ...or Promise style
bufferedSpawn('git', ['clone', '[email protected]/bower/bower'], { cwd: '.' })
.then((output) => {
console.log(output.stdout);
console.log(output.stderr);
}, (err) => {
// Both stdout and stderr are also set on the error object
console.error(`Command failed with error code of #${err.status}`);
});
The actual child process is available if necessary:
const buffspawn('buffered-spawn');
// Callback style
const cp = buffspawn('git', ['clone', '[email protected]/bower/bower'], () => {}};
// ...or Promise style
const promise = buffspawn('git', ['clone', '[email protected]/bower/bower']);
const cp = promise.cp;
As said before, buffered-spawn
uses cross-spawn
to actually spawn the process. If you are having trouble running Windows such as wmic which has its own arguments parser, you may disable like so:
const cp = buffspawn('wmic', [
'logicaldisk', 'where', 'DeviceID="Z:"',
'get' 'freeSpace,size'
], { crossSpawn: false }, () => {}};
Tests
$ npm test
License
Released under the MIT License.