Interface RunResult

Result of a CLI invocation.

interface RunResult {
    command?: Command;
    error?: Error;
    invalidArguments?: readonly InvalidArgument[];
    runState: RunState;
}

Index

Properties

command? error? invalidArguments? runState

Properties

`Optional` `Readonly`command

command?: Command

Populated if runState is RunState.SUCCESS, RunState.PARSE_ERROR or RunState.EXECUTION_ERROR.

`Optional` `Readonly`error

error?: Error

Populated if runState is RunState.EXECUTION_ERROR or RunState.RUNTIME_ERROR.

`Optional` `Readonly`invalidArguments

invalidArguments?: readonly InvalidArgument[]

Populated if runState is RunState.PARSE_ERROR

`Readonly`runState

runState: RunState

The state after processing the invocation.