Description

Thrown at the end of a --keep-going run when one or more (name, action) pairs failed. Carries the partial results (the successful operation outcomes that did run) and the structured failures list so the runner can surface them in RunnerResult.failures instead of discarding the partial work. Extends ShowHelpError so the CLI still prints help, matching the pre-existing keep-going failure reporting.

Hierarchy (view full)

Constructors

Properties

#private: any
cause?: unknown
failures: RunFailure[]

Description

The structured list of failed pairs.

message: string
name: string
results: ActionResult[]

Description

The operation outcomes that succeeded before the failures.

stack?: string
statuses: ActionStatusEntry[]

Description

Per-action three-state outcomes (ok / skipped / failed), one entry per rendered action, so the runner can surface RunnerResult.statuses for a --keep-going run that hit failures.

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.

Accessors

  • get code(): string
  • Returns string

  • get meta(): any
  • Returns any

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
    • Optional constructorOpt: Function

    Returns void