Skip to content

ChildProcess ​

ChildProcess owns a started external program and exposes its standard descriptors as capability-separated streams.

tyrus
interface ChildProcess {
    readonly pid: u32;
    readonly stdin: WritableStream<u8[]>;
    readonly stdout: ReadableStream<u8[]>;
    readonly stderr: ReadableStream<u8[]>;
    wait(): Promise<Result<i32, ProcessError>>;
    kill(): Promise<Result<void, ProcessError>>;
}

Members ​

MemberSignaturePurpose
pidu32Operating-system process identifier.
stdinWritableStream<u8[]>Sends bytes to standard input.
stdoutReadableStream<u8[]>Receives standard output bytes.
stderrReadableStream<u8[]>Receives standard error bytes.
wait()() => Promise<Result<i32, ProcessError>>Resolves with the exit code or a recoverable process error.
kill()() => Promise<Result<void, ProcessError>>Requests termination of a running child and reports recoverable failures.

Usage and errors ​

tyrus
async function stop(child: ChildProcess): Promise<Result<i32, ProcessError>> {
    const output: ReadableStream<u8[]> = child.stdout;
    await child.stdin.close();
    await child.kill()?;
    return await child.wait();
}

error

tyrus
async function invalid(child: ChildProcess): Promise<void> {
await child.stdout.write([1, 2, 3]); 
}

Closing stdin delivers EOF without closing output. Output and error streams remain independently readable after kill() so accepted bytes can drain. Releasing the last handle terminates and reaps a child that is still running.