Interface ExecaSyncReturnValue<StdoutErrorType>

interface ExecaSyncReturnValue<StdoutErrorType> {
    command: string;
    exitCode: number;
    failed: boolean;
    killed: boolean;
    signal?: string;
    signalDescription?: string;
    stderr: StdoutErrorType;
    stdout: StdoutErrorType;
    timedOut: boolean;
}

Type Parameters

  • StdoutErrorType = string

Hierarchy (view full)

Properties

command exitCode failed killed signal? signalDescription? stderr stdout timedOut

Properties

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.

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