string
AsyncIterable
<{
stream
: "stdout"
| "stderr"
;
data
: string
;
}, any
, any
>
An async iterable of log entries from the command output.
Promise
<CommandFinished
>
A CommandFinished instance with populated exit code.
stdout
, stderr
, or both as a string.
NOTE: This may throw string conversion errors if the command does
not output valid Unicode.
Parameter | Type | Default value | Description |
---|---|---|---|
stream | "stdout" | "stderr" | "both" | "both" | The output stream to read: “stdout”, “stderr”, or “both”. |
Promise
<string
>
The output of the specified stream(s) as a string.
stdout
as a string.
NOTE: This may throw string conversion errors if the command does
not output valid Unicode.
Promise
<string
>
The standard output of the command.
stderr
as a string.
NOTE: This may throw string conversion errors if the command does
not output valid Unicode.
Promise
<string
>
The standard error output of the command.
Parameter | Type |
---|---|
signal? | Signal |
Promise
<void
>
Promise<void>
.