@cuties/child-process
v1.1.1
Published
Cutie extension for child-process module in Node.
Readme
cutie-child-process
Cutie extension for child-process module in Node. It's based on the Async Tree Pattern.
Examples
You can find examples of using this library in the test directory.
Install
npm install @cuties/child-process
Run test
npm test
Run build
npm run build
Usage
const {
// Needed async objects here from the table below
} = require('@cuties/child-process');For more information about parameters in the async objects visit docs of Node for process module.
| Async Object | Async/sync call | Parameters(default value/description) | Representation result |
| ------------- | ----------------| ---------- | --------------------- |
| Channel | childProcess.channel | childProcess | object\|undefined |
| ChildProcessWithCloseEvent | childProcess.on('close', event) | childProcess, event(Event with definedBody(code, signal)) | childProcess |
| ChildProcessWithDisconnectEvent | childProcess.on('disconnect', event) | childProcess, event(Event with definedBody()) | childProcess |
| ChildProcessWithErrorEvent | childProcess.on('error', event) | childProcess, event(Event with definedBody(error)) | childProcess |
| ChildProcessWithExitEvent | childProcess.on('exit', event) | childProcess, event(Event with definedBody(code, signal)) | childProcess |
| ChildProcessWithMessageEvent | childProcess.on('message', event) | childProcess, event(Event with definedBody(message, sendHandle)) | childProcess |
| Executed | exec | command[, options][, callback] | childProcess |
| FileExecuted | execFile | file[,args][, options][, callback] | childProcess |
| Forked | fork | modulePath[,args][, options] | childProcess |
| IsConnected | childProcess.connected | childProcess | boolean |
| IsKilled | childProcess.killed | childProcess | boolean |
| KilledChildProcess | childProcess.kill | childProcess | childProcess |
| Pid | childProcess.pid | childProcess | number |
| ResultFromExecutedSync | execSync | command[,args][,options] | buffer\|string |
| ResultFromFileExecutedSync | execFileSync | file[,args][,options] | buffer\|string |
| ResultObjectFromSpawnedSync | spawnSync | command[,args][,options] | object |
| SentMessage | childProcess.send | childProcess, message, sendHandle, options | message |
| Spawned | spawn | command[,args][,options] | childProcess |
| StdErr | childProcess.stderr | childProcess | stream |
| StdIn | childProcess.stdin | childProcess | stream |
| StdOut | childProcess.stdout | childProcess | stream |
