mirror of https://github.com/docker/docs.git
1.8 KiB
1.8 KiB
| title | description | keywords |
|---|---|---|
| Docker extension API reference | Docker extension API reference | Docker, extensions, sdk, API, reference |
Interface: ExecStreamOptions
Table of contents
Methods
Properties
Methods
onOutput
▸ Optional onOutput(data): void
Invoked when receiving output from command execution.
By default, the output is split into chunks at arbitrary boundaries.
If you prefer the output to be split into complete lines, set splitOutputLines
to true. The callback is then invoked once for each line.
Parameters
| Name | Type | Description |
|---|---|---|
data |
{ stdout: string ; stderr?: undefined } | { stdout?: undefined ; stderr: string } |
output content. Can include either stdout string, or stderr string, one at a time. |
Returns
void
onError
▸ Optional onError(error): void
Invoked to report error if the executed command errors.
Parameters
| Name | Type | Description |
|---|---|---|
error |
any |
the error happening in the executed command |
Returns
void
onClose
▸ Optional onClose(exitCode): void
Invoked when process exits.
Parameters
| Name | Type | Description |
|---|---|---|
exitCode |
number |
the process exit code |
Returns
void
Properties
splitOutputLines
• Optional Readonly splitOutputLines: boolean
Specifies the behaviour invoking onOutput(data). Raw output by default, splitting output at any position. If set to true, onOutput will be invoked once for each line.