Interface ExecaError<StdoutErrorType>

interface ExecaError<StdoutErrorType> {
    all?: StdoutErrorType;
    cause?: unknown;
    command: string;
    exitCode: number;
    failed: boolean;
    isCanceled: boolean;
    killed: boolean;
    message: string;
    name: string;
    originalMessage?: string;
    shortMessage: string;
    signal?: string;
    signalDescription?: string;
    stack?: string;
    stderr: StdoutErrorType;
    stdout: StdoutErrorType;
    timedOut: boolean;
}

Type Parameters

  • StdoutErrorType = string

Hierarchy (view full)

Properties

all? cause? command exitCode failed isCanceled killed message name originalMessage? shortMessage signal? signalDescription? stack? 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

Optionalcause

cause?: unknown

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.

message

message: string

Error message when the child process failed to run. In addition to the underlying error message, it also contains some information related to why the child process errored.

The child process stderr then stdout are appended to the end, separated with newlines and not interleaved.

name

name: string

OptionaloriginalMessage

originalMessage?: string

Original error message. This is the same as the message property except it includes neither the child process stdout/stderr nor some additional information added by Execa.

This is undefined unless the child process exited due to an error event or a timeout.

shortMessage

shortMessage: string

This is the same as the message property except it does not include the child process stdout/stderr.

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.

Optionalstack

stack?: string

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