#Class: ContractMatrixViolationError

Every harness failure. The message carries the route identity, the module provenance, and the recovery step, so a failing consumer test never has to be re-run under a debugger to learn which route and which proof level produced it.

#Extends

• AgentTestError

#Constructors

#Constructor

new ContractMatrixViolationError(message, failures, report, options): ContractMatrixViolationError

#Parameters

#message

string

#failures

readonly ContractMatrixFailure[]

#report

ContractMatrixReport

#options

#details

readonly string[]

#recovery

string

#Returns

ContractMatrixViolationError

#Overrides

AgentTestError.constructor

#Properties

#~effect/ErrorReporter/attributes?

readonly optional ~effect/ErrorReporter/attributes?: ReadonlyRecord<string, unknown>

#Inherited from

AgentTestError.~effect/ErrorReporter/attributes

#~effect/ErrorReporter/ignore?

readonly optional ~effect/ErrorReporter/ignore?: boolean

#Inherited from

AgentTestError.~effect/ErrorReporter/ignore

#~effect/ErrorReporter/severity?

readonly optional ~effect/ErrorReporter/severity?: Severity

#Inherited from

AgentTestError.~effect/ErrorReporter/severity

#~effect/Runtime/errorExitCode?

readonly optional ~effect/Runtime/errorExitCode?: number

#Inherited from

AgentTestError.~effect/Runtime/errorExitCode

#~effect/Runtime/errorReported?

readonly optional ~effect/Runtime/errorReported?: boolean

#Inherited from

AgentTestError.~effect/Runtime/errorReported

#cause?

optional cause?: unknown

#Inherited from

AgentTestError.cause

#code

readonly code: AgentTestErrorCode

#Inherited from

AgentTestError.code

#failures

readonly failures: readonly ContractMatrixFailure[]

#message

message: string

#Inherited from

AgentTestError.message

#name

name: string

#Inherited from

AgentTestError.name

#provenance?

readonly optional provenance?: RenderedRouteProvenance

#Inherited from

AgentTestError.provenance

#report

readonly report: ContractMatrixReport

#stack?

optional stack?: string

#Inherited from

AgentTestError.stack

#stackTraceLimit

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

#Inherited from

AgentTestError.stackTraceLimit

#Methods

#captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

#constructorOpt?

Function

#Returns

void

#Inherited from

AgentTestError.captureStackTrace

#prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

#Parameters

#err

Error

#stackTraces

CallSite[]

#Returns

any

#See

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

#Inherited from

AgentTestError.prepareStackTrace