Type Alias ParseResult

ParseResult:
    | { status: "ok" }
    | { status: "help" }
    | { detail?: string[]; error: string; showUsage: boolean; status: "error" }

The outcome of parsing without exiting: ok, help, or error. Values are available after ok.

Type Declaration

{ status: "ok" }
{ status: "help" }
{ detail?: string[]; error: string; showUsage: boolean; status: "error" }
- Optionaldetail?: string[]
  
  Additional failure details and installation hints.
- error: string
  
  Human-readable validation, configuration, or argument error.
- showUsage: boolean
  
  Whether help should accompany the error.
- status: "error"
  
  Parsing failed.