Interface: Exec

Callable#

Exec#

▸ Exec(cmd, args, options?): Promise<ExecResult>

Executes a command.

Since

0.2.0

Parameters#

Name	Type	Description
cmd	string	The command to execute.
args	string[]	The arguments of the command to execute.
options?	ExecOptions	The list of options.

Returns#

Promise<ExecResult>

A promise that will resolve once the command finishes.

Exec#

▸ Exec(cmd, args, options): ExecProcess

Streams the result of a command if stream is specified in the options parameter.

Specify the stream if the output of your command is too long or if you need to stream things indefinitely (for example container logs).

Since

0.2.2

Parameters#

Name	Type	Description
cmd	string	The command to execute.
args	string[]	The arguments of the command to execute.
options	SpawnOptions	The list of options.

Returns#

ExecProcess

The spawned process.