@shopify/cli-kit
    Preparing search index...

    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)

    Index
    constructor
    args code? command customSections? details? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type

    • Parameters

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

      Returns ExternalError

    args: string[]
    code?: string

    A stable code for JSON consumers to identify this error, included only when known.

    command: string
    customSections?: CustomSection[]
    details?: unknown

    Selected JSON-serializable data to include in JSON errors. Never attach the raw error or request.

    formattedMessage?: TokenItem
    nextSteps?: TokenItem<InlineToken>[]
    skipOclifErrorHandling: boolean
    tryMessage: TokenItem | null
    type: FatalErrorType

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties