Module subprocess
A module for spawning processes, connecting to their input/output/errput and returning their response codes.
Functions
- command(command..., [options])
- createProcess(args)
- status(command..., [options])
- system(command..., [options])
Process
The Process object can be used to control and obtain information about a subprocess started using createProcess().
Process.prototype.connect (input, output, errput)
Connects the process's steams to the argument streams and starts threads to copy the data asynchronously.
Parameters
| Stream | input | output stream to connect to the process's input stream |
| Stream | output | input stream to connect to the process's output stream |
| Stream | errput | input stream to connect to the process's error stream |
Process.prototype.kill ()
Kills the subprocess.
Process.prototype.stderr
The process's error stream.
Process.prototype.stdin
The process's input stream.
Process.prototype.stdout
The process's output stream.
Process.prototype.wait ()
Wait for the process to terminate and return its exit status.
command (command..., [options])
executes a given command and returns the standard output. If the exit status is non-zero, throws an Error.
Parameters
| String | command... | command and optional arguments as single or multiple string parameters |
| Object | [options] | options object. This may contain a `dir` string property specifying the directory to run the process in and a `env` object property specifying additional environment variable mappings. |
Returns
| String the standard output of the command |
createProcess (args)
Low-level function to spawn a new process. The function takes an object
argument containing the following properties where all properties except
command are optional: * command a string or array of strings containing the
command to execute * dir the directory to run the process in * env
alternative environment variables. If null the process inherits the
environment of the current process. * binary a boolean flag that uses raw
binary streams instead of text streams * encoding the character encoding to
use for text streams
Parameters
| Object | args | an object containing the process command and options. |
Returns
| a Process object |
See
status (command..., [options])
Executes a given command quietly and returns the exit status.
Parameters
| String | command... | command and optional arguments as single or multiple string parameters |
| Object | [options] | options object. This may contain a `dir` string property specifying the directory to run the process in and a `env` object property specifying additional environment variable mappings. |
Returns
| Number exit status |
system (command..., [options])
executes a given command, attached to this process's output and error streams, and returns the exit status.
Parameters
| String | command... | command and optional arguments as single or multiple string parameters |
| Object | [options] | options object. This may contain a `dir` string property specifying the directory to run the process in and a `env` object property specifying additional environment variable mappings. |
Returns
| Number exit status |
