Class FatalErrorAbstract

constructor

• new FatalError(
      message:
          | string
          | LinkToken
          | UserInputToken
          | ListToken
          | { command: string }
          | { char: string }
          | { subdued: string }
          | { filePath: string }
          | BoldToken
          | { info: string }
          | { warn: string }
          | { error: string }
          | Token[]
          | TokenizedString,
      type: FatalErrorType,
      tryMessage?:
          | string
          | LinkToken
          | UserInputToken
          | ListToken
          | { command: string }
          | { char: string }
          | { subdued: string }
          | { filePath: string }
          | BoldToken
          | { info: string }
          | { warn: string }
          | { error: string }
          | Token[]
          | TokenizedString
          | null,
      nextSteps?: TokenItem<InlineToken>[],
      customSections?: CustomSection[],
  ): FatalError

  Creates a new FatalError error.

  Parameters

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

    The error message.

  • type: FatalErrorType

    The type of fatal error.

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

    The message that recommends next steps to the user. You can pass a string a TokenizedString or a TokenItem if you need to style the message inside the error Banner component.

  • OptionalnextSteps: TokenItem<InlineToken>[]

    Message to show as "next steps" with suggestions to solve the issue.

  • OptionalcustomSections: CustomSection[]

    Custom sections to show in the error banner. To be used if nextSteps is not enough.

  Returns FatalError

Optionalcode

OptionalcustomSections

Optionaldetails

OptionalformattedMessage

OptionalnextSteps

skipOclifErrorHandling

tryMessage

type