mirror of https://github.com/docker/docs.git
1.4 KiB
1.4 KiB
| description | keywords | skip_read_time |
|---|---|---|
| Docker extension API reference | Docker, extensions, sdk, API, reference | true |
Interface: Exec
Callable
Exec
▸ Exec(cmd, args): Promise<ExecResult>
Executes a command.
Parameters
| Name | Type | Description |
|---|---|---|
cmd |
string |
The command to execute. |
args |
string[] |
The arguments of the command to execute. |
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).
Parameters
| Name | Type | Description |
|---|---|---|
cmd |
string |
The command to execute. |
args |
string[] |
The arguments of the command to execute. |
options |
Object |
The list of options. |
options.stream |
ExecStreamOptions |
Provides three functions: onOutput (invoked every time stdout or stderr is received), onError and onClose (invoked when the stream has ended). |