Class ExternalError

An external error is similar to Abort but has extra command and args attributes. This is useful to represent errors coming from external commands, usually executed by execa.

Hierarchy (View Summary)

Constructors

constructor

Properties

args command customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type

Constructors

constructor

  • new ExternalError(
        message: OutputMessage,
        command: string,
        args: string[],
        tryMessage?:
            | null
            | string
            | TokenizedString
            | { command: string }
            | LinkToken
            | { char: string }
            | UserInputToken
            | { subdued: string }
            | { filePath: string }
            | ListToken
            | BoldToken
            | { info: string }
            | { warn: string }
            | { error: string }
            | Token[],
    ): ExternalError

  • Parameters

    • message: OutputMessage
    • command: string
    • args: string[]
    • tryMessage:
          | null
          | string
          | TokenizedString
          | { command: string }
          | LinkToken
          | { char: string }
          | UserInputToken
          | { subdued: string }
          | { filePath: string }
          | ListToken
          | BoldToken
          | { info: string }
          | { warn: string }
          | { error: string }
          | Token[] = null

    Returns ExternalError

Properties

args

args: string[]

command

command: string

OptionalcustomSections

customSections?: CustomSection[]

OptionalformattedMessage

formattedMessage?: TokenItem

OptionalnextSteps

nextSteps?: TokenItem<InlineToken>[]

skipOclifErrorHandling

skipOclifErrorHandling: boolean

tryMessage

tryMessage: null | TokenItem

type

type: FatalErrorType

Settings

Member Visibility

On This Page

Constructors
Properties