Interface CliResult<TValues, TPositionals>

Result from CLI execution (extends ParseResult with command name).

interface CliResult<
    TValues = Record<string, unknown>,
    TPositionals extends readonly unknown[] = readonly unknown[],
> {
    command?: string;
    positionals: TPositionals;
    values: TValues;
}

Type Parameters

TValues = Record<string, unknown>
TPositionals extends readonly unknown[] = readonly unknown[]

Hierarchy (View Summary)

ParseResult<TValues, TPositionals>
- CliResult

Index

Properties

command? positionals values

Properties

`Optional`command

command?: string

The command that was executed, if any

positionals

positionals: TPositionals

values

values: TValues