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 stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    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).

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods