Class SyncChildProcess

constructor

• new SyncChildProcess(command: string, options?: Options): SyncChildProcess

  Creates a new synchronous process running command with args.

  Parameters

  • command: string
  • Optionaloptions: Options

  Returns SyncChildProcess

• new SyncChildProcess(
      command: string,
      args: string[],
      options?: Options,
  ): SyncChildProcess

  Parameters

  • command: string
  • args: string[]
  • Optionaloptions: Options

  Returns SyncChildProcess

Readonlystdin

kill

• kill(signal?: number | Signals): void

  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

next

• next(): IteratorResult<StdoutEvent | StderrEvent, ExitEvent | undefined>

  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 starting the child process, the first call to this will throw that error, and the next call will an [ExitEvent] with status 1. If there's an error writing to stdin, the next call to this will throw that error, but the child process won't exit.

  Returns IteratorResult<StdoutEvent | StderrEvent, ExitEvent | undefined>