Class - Command

A command executed in a Sandbox.

You can wait on commands to access their CommandFinished.exitCode, and iterate over their output with logs.

​

See

Sandbox.runCommand to start a command.

​

Extended by

• CommandFinished

​

Accessors

​

cmdId

​

Get Signature

get cmdId(): string;

ID of the command execution.

Returns

string

​

Methods

​

logs()

logs(): AsyncIterable<{
  stream: "stdout" | "stderr";
  data: string;
}, any, any>;

Iterate over the output of this command.

for await (const log of cmd.logs()) {
  if (log.stream === "stdout") {
    process.stdout.write(log.data);
  } else {
    process.stderr.write(log.data);
  }
}

​

Returns

AsyncIterable<{ stream: "stdout" | "stderr"; data: string; }, any, any>

An async iterable of log entries from the command output.

​

See

Command.stdout, Command.stderr, and Command.output to access output as a string.

​

wait()

wait(): Promise<CommandFinished>;

Wait for a command to exit and populate its exit code.

await cmd.wait()
if (cmd.exitCode != 0) {
  console.error("Something went wrong...")
}

​

Returns

Promise<CommandFinished>

A CommandFinished instance with populated exit code.

​

output()

output(stream: "stdout" | "stderr" | "both"): Promise<string>;

Get the output of stdout, stderr, or both as a string.

NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​

Parameters

​

Returns

Promise<string>

The output of the specified stream(s) as a string.

​

stdout()

stdout(): Promise<string>;

Get the output of stdout as a string.

NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​

Returns

Promise<string>

The standard output of the command.

​

stderr()

stderr(): Promise<string>;

Get the output of stderr as a string.

NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​

Returns

Promise<string>

The standard error output of the command.

​

kill()

kill(signal?: Signal): Promise<void>;

Kill a running command in a sandbox.

​

Parameters

​

Returns

Promise<void>

Promise<void>.