1.0.0 • Published 6 years ago

@guseyn/cutie-child-process v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

cutie-child-process

NPM Version Build Status codecov

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 ObjectAsync/sync callParameters(default value/description)Representation result
ChannelchildProcess.channelchildProcessobject\|undefined
ChildProcessWithCloseEventchildProcess.on('close', event)childProcess, event(Event with definedBody(code, signal))childProcess
ChildProcessWithDisconnectEventchildProcess.on('disconnect', event)childProcess, event(Event with definedBody())childProcess
ChildProcessWithErrorEventchildProcess.on('error', event)childProcess, event(Event with definedBody(error))childProcess
ChildProcessWithExitEventchildProcess.on('exit', event)childProcess, event(Event with definedBody(code, signal))childProcess
ChildProcessWithMessageEventchildProcess.on('message', event)childProcess, event(Event with definedBody(message, sendHandle))childProcess
Executedexeccommand[, options][, callback]childProcess
FileExecutedexecFilefile[,args][, options][, callback]childProcess
ForkedforkmodulePath[,args][, options]childProcess
IsConnectedchildProcess.connectedchildProcessboolean
IsKilledchildProcess.killedchildProcessboolean
KilledChildProcesschildProcess.killchildProcesschildProcess
PidchildProcess.pidchildProcessnumber
ResultFromExecutedSyncexecSynccommand[,args][,options]buffer\|string
ResultFromFileExecutedSyncexecFileSyncfile[,args][,options]buffer\|string
ResultObjectFromSpawnedSyncspawnSynccommand[,args][,options]object
SentMessagechildProcess.sendchildProcess, message, sendHandle, optionsmessage
Spawnedspawncommand[,args][,options]childProcess
StdErrchildProcess.stderrchildProcessstream
StdInchildProcess.stdinchildProcessstream
StdOutchildProcess.stdoutchildProcessstream