Member Junction
    Preparing search index...

    Class InstallerError

    Structured error thrown by installer phases when a recoverable or terminal failure occurs.

    Unlike a generic Error, InstallerError carries machine-readable metadata that frontends use to render actionable diagnostics:

    • Phase identifies which phase failed (for checkpoint/resume).
    • Code is a stable, machine-readable error code for programmatic handling.
    • SuggestedFix is a human-readable remediation step displayed to the user.

    The engine catches InstallerError during phase execution, records it in the checkpoint state file, and emits it via the error event channel.

    try {
      await phase.Run(context);
    } catch (err) {
      if (err instanceof InstallerError) {
        console.error(`[${err.Phase}] ${err.Code}: ${err.message}`);
        console.error(`Fix: ${err.SuggestedFix}`);
      }
    }

    Hierarchy

    • Error
      • InstallerError
    Index

    Constructors

    constructor

    Properties

    cause? Code message name Phase stack? SuggestedFix prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace

    Constructors

    • Create a new InstallerError.

      Parameters

      • phase: PhaseId

        The phase where the error occurred.

      • code: string

        Machine-readable error code (e.g., 'NPM_INSTALL_FAILED').

      • message: string

        Human-readable error description.

      • suggestedFix: string

        Actionable remediation step for the user.

      Returns InstallerError

    Properties

    cause?: unknown
    Code: string

    Machine-readable error code (e.g., 'NODE_VERSION', 'DOWNLOAD_FAILED'). Stable across versions — safe for programmatic error handling.

    message: string
    name: string
    Phase: PhaseId

    The installer phase where this error originated.

    stack?: string
    SuggestedFix: string

    Human-readable remediation step displayed to the user. Should be a concrete, actionable instruction (e.g., a command to run or a URL to visit).

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods