interface RunResult

Result of a CLI invocation.

Properties

The state after processing the invocation.

readonly
optional
command: Command

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

readonly
optional
invalidArguments: ReadonlyArray<InvalidArgument>

Populated if runState is RunState.PARSE_ERROR

readonly
optional
error: Error

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

Usage

import type RunResult from ".";