summaryrefslogtreecommitdiff
path: root/cli
diff options
context:
space:
mode:
Diffstat (limited to 'cli')
-rw-r--r--cli/tests/unit/command_test.ts45
-rw-r--r--cli/tsc/diagnostics.rs1
-rw-r--r--cli/tsc/dts/lib.deno.unstable.d.ts36
3 files changed, 48 insertions, 34 deletions
diff --git a/cli/tests/unit/command_test.ts b/cli/tests/unit/command_test.ts
index 0b8aa934b..d58053c84 100644
--- a/cli/tests/unit/command_test.ts
+++ b/cli/tests/unit/command_test.ts
@@ -31,13 +31,13 @@ tryExit();
Deno.writeFileSync(`${cwd}/${programFile}`, enc.encode(program));
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
cwd,
args: ["run", "--allow-read", programFile],
stdout: "inherit",
stderr: "inherit",
});
- child.spawn();
+ const child = command.spawn();
// Write the expected exit code *after* starting deno.
// This is how we verify that `Child` is actually asynchronous.
@@ -55,7 +55,7 @@ tryExit();
Deno.test(
{ permissions: { run: true, read: true } },
async function commandStdinPiped() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"if (new TextDecoder().decode(await Deno.readAll(Deno.stdin)) !== 'hello') throw new Error('Expected \\'hello\\'')",
@@ -64,7 +64,7 @@ Deno.test(
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
assertThrows(() => child.stdout, TypeError, "stdout is not piped");
assertThrows(() => child.stderr, TypeError, "stderr is not piped");
@@ -85,14 +85,14 @@ Deno.test(
Deno.test(
{ permissions: { run: true, read: true } },
async function commandStdoutPiped() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"await Deno.stdout.write(new TextEncoder().encode('hello'))",
],
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
assertThrows(() => child.stdin, TypeError, "stdin is not piped");
assertThrows(() => child.stderr, TypeError, "stderr is not piped");
@@ -118,14 +118,14 @@ Deno.test(
Deno.test(
{ permissions: { run: true, read: true } },
async function commandStderrPiped() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"await Deno.stderr.write(new TextEncoder().encode('hello'))",
],
stdout: "null",
});
- child.spawn();
+ const child = command.spawn();
assertThrows(() => child.stdin, TypeError, "stdin is not piped");
assertThrows(() => child.stdout, TypeError, "stdout is not piped");
@@ -158,13 +158,13 @@ Deno.test(
write: true,
});
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"Deno.stderr.write(new TextEncoder().encode('error\\n')); Deno.stdout.write(new TextEncoder().encode('output\\n'));",
],
});
- child.spawn();
+ const child = command.spawn();
await child.stdout.pipeTo(file.writable, {
preventClose: true,
});
@@ -189,7 +189,7 @@ Deno.test(
await Deno.writeFile(fileName, encoder.encode("hello"));
const file = await Deno.open(fileName);
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"if (new TextDecoder().decode(await Deno.readAll(Deno.stdin)) !== 'hello') throw new Error('Expected \\'hello\\'')",
@@ -198,7 +198,7 @@ Deno.test(
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
await file.readable.pipeTo(child.stdin, {
preventClose: true,
});
@@ -212,12 +212,12 @@ Deno.test(
Deno.test(
{ permissions: { run: true, read: true } },
async function commandKillSuccess() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: ["eval", "setTimeout(() => {}, 10000)"],
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
child.kill("SIGKILL");
const status = await child.status;
@@ -236,12 +236,12 @@ Deno.test(
Deno.test(
{ permissions: { run: true, read: true } },
async function commandKillFailed() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: ["eval", "setTimeout(() => {}, 5000)"],
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
assertThrows(() => {
// @ts-expect-error testing runtime error of bad signal
@@ -255,12 +255,12 @@ Deno.test(
Deno.test(
{ permissions: { run: true, read: true } },
async function commandKillOptional() {
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: ["eval", "setTimeout(() => {}, 10000)"],
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
child.kill();
const status = await child.status;
@@ -280,7 +280,7 @@ Deno.test(
{ permissions: { run: true, read: true } },
async function commandAbort() {
const ac = new AbortController();
- const child = new Deno.Command(Deno.execPath(), {
+ const command = new Deno.Command(Deno.execPath(), {
args: [
"eval",
"setTimeout(console.log, 1e8)",
@@ -289,7 +289,7 @@ Deno.test(
stdout: "null",
stderr: "null",
});
- child.spawn();
+ const child = command.spawn();
queueMicrotask(() => ac.abort());
const status = await child.status;
assertEquals(status.success, false);
@@ -735,11 +735,12 @@ Deno.test(
const programFile = "unref.ts";
const program = `
-const child = await new Deno.Command(Deno.execPath(), {
+const command = await new Deno.Command(Deno.execPath(), {
cwd: Deno.args[0],
stdout: "piped",
args: ["run", "-A", "--unstable", Deno.args[1]],
-});child.spawn();
+});
+const child = command.spawn();
const readable = child.stdout.pipeThrough(new TextDecoderStream());
const reader = readable.getReader();
// set up an interval that will end after reading a few messages from stdout,
diff --git a/cli/tsc/diagnostics.rs b/cli/tsc/diagnostics.rs
index 05502dca4..4413398c2 100644
--- a/cli/tsc/diagnostics.rs
+++ b/cli/tsc/diagnostics.rs
@@ -31,6 +31,7 @@ const UNSTABLE_DENO_PROPS: &[&str] = &[
"umask",
"spawnChild",
"Child",
+ "ChildProcess",
"spawn",
"spawnSync",
"SpawnOptions",
diff --git a/cli/tsc/dts/lib.deno.unstable.d.ts b/cli/tsc/dts/lib.deno.unstable.d.ts
index eaa40abc5..ce609736b 100644
--- a/cli/tsc/dts/lib.deno.unstable.d.ts
+++ b/cli/tsc/dts/lib.deno.unstable.d.ts
@@ -1639,14 +1639,14 @@ declare namespace Deno {
* ],
* stdin: "piped",
* });
- * command.spawn();
+ * const child = command.spawn();
*
* // open a file and pipe the subprocess output to it.
- * command.stdout.pipeTo(Deno.openSync("output").writable);
+ * child.stdout.pipeTo(Deno.openSync("output").writable);
*
* // manually close stdin
- * command.stdin.close();
- * const status = await command.status;
+ * child.stdin.close();
+ * const status = await child.status;
* ```
*
* ```ts
@@ -1678,13 +1678,6 @@ declare namespace Deno {
* @category Sub Process
*/
export class Command {
- get stdin(): WritableStream<Uint8Array>;
- get stdout(): ReadableStream<Uint8Array>;
- get stderr(): ReadableStream<Uint8Array>;
- readonly pid: number;
- /** Get the status of the child process. */
- readonly status: Promise<CommandStatus>;
-
constructor(command: string | URL, options?: CommandOptions);
/**
* Executes the {@linkcode Deno.Command}, waiting for it to finish and
@@ -1711,8 +1704,27 @@ declare namespace Deno {
/**
* Spawns a streamable subprocess, allowing to use the other methods.
*/
- spawn(): void;
+ spawn(): ChildProcess;
+ }
+
+ /** **UNSTABLE**: New API, yet to be vetted.
+ *
+ * The interface for handling a child process returned from
+ * {@linkcode Deno.Command.spawn}.
+ *
+ * @category Sub Process
+ */
+ export class ChildProcess {
+ get stdin(): WritableStream<Uint8Array>;
+ get stdout(): ReadableStream<Uint8Array>;
+ get stderr(): ReadableStream<Uint8Array>;
+ readonly pid: number;
+ /** Get the status of the child. */
+ readonly status: Promise<CommandStatus>;
+ /** Waits for the child to exit completely, returning all its output and
+ * status. */
+ output(): Promise<CommandOutput>;
/** Kills the process with given {@linkcode Deno.Signal}. Defaults to
* `"SIGTERM"`. */
kill(signo?: Signal): void;
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-27 11:48:57 +0000