A child process that runs synchronously while also allowing the user to interact with it before it shuts down.

Implements

Constructors

Properties

Methods

Constructors

Properties

stdin: Writable

The standard input stream to write to the process.

Methods

  • Sends a signal (SIGTERM by default) to the child process.

    This has no effect if the process has already exited.

    Parameters

    • Optionalsignal: number | Signals

    Returns void

  • Blocks until the child process is ready to emit another event, then returns that event. This will return an [IteratorReturnResult] with an [ExitEvent] once when the process exits. If it's called again after that, it will return {done: true} without a value.

    If there's an error running the child process, this will throw that error.

    Returns IteratorResult<StdoutEvent | StderrEvent, undefined | ExitEvent>