Interface: Exec

Table of contents

Callable

Exec

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

Executes a command.

Since

0.2.0

Parameters

NameTypeDescription
cmdstringThe command to execute.
argsstring[]The arguments of the command to execute.
options?ExecOptionsThe 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

NameTypeDescription
cmdstringThe command to execute.
argsstring[]The arguments of the command to execute.
optionsSpawnOptionsThe list of options.

Returns

ExecProcess

The spawned process.