Interface ExecaReturnValue<StdoutErrorType>

Result of a child process execution. On success this is a plain object. On failure this is also an Error instance.

The child process fails when:

  • its exit code is not 0
  • it was killed with a signal
  • timing out
  • being canceled
  • there's not enough memory or there are already too many child processes
interface ExecaReturnValue<StdoutErrorType> {
    all?: StdoutErrorType;
    command: string;
    exitCode: number;
    failed: boolean;
    isCanceled: boolean;
    killed: boolean;
    signal?: string;
    signalDescription?: string;
    stderr: StdoutErrorType;
    stdout: StdoutErrorType;
    timedOut: boolean;
}

Type Parameters

  • StdoutErrorType = string

Hierarchy (view full)

Properties

all? command exitCode failed isCanceled killed signal? signalDescription? stderr stdout timedOut

Properties

Optionalall

all?: StdoutErrorType

The output of the process with stdout and stderr interleaved.

This is undefined if either:

  • the all option is false (default value)
  • execa.sync() was used

command

command: string

The file and arguments that were run.

exitCode

exitCode: number

The numeric exit code of the process that was run.

failed

failed: boolean

Whether the process failed to run.

isCanceled

isCanceled: boolean

Whether the process was canceled.

killed

killed: boolean

Whether the process was killed.

Optionalsignal

signal?: string

The name of the signal that was used to terminate the process. For example, SIGFPE.

If a signal terminated the process, this property is defined and included in the error message. Otherwise it is undefined.

OptionalsignalDescription

signalDescription?: string

A human-friendly description of the signal that was used to terminate the process. For example, Floating point arithmetic error.

If a signal terminated the process, this property is defined and included in the error message. Otherwise it is undefined. It is also undefined when the signal is very uncommon which should seldomly happen.

stderr

stderr: StdoutErrorType

The output of the process on stderr.

stdout

stdout: StdoutErrorType

The output of the process on stdout.

timedOut

timedOut: boolean

Whether the process timed out.

Settings

Member Visibility

On This Page

Properties