arvo-event-handler
    Preparing search index...

    Class ConfigViolation

    ConfigViolation indicates system configuration or routing issues where events are mismatched with their handlers. This occurs separately from contract violations and represents problems with the system topology itself, such as:

    • Events sent to handlers not configured to process them
    • Mismatched event types not covered by handler contracts
    • Configuration conflicts between services

    Requires explicit resolution as it indicates fundamental routing or setup issues.

    Hierarchy

    • ViolationError<"Config">
      • ConfigViolation
    Index

    Constructors

    • Parameters

      • message: string
      • Optionalmetadata: Record<string, any>

      Returns ConfigViolation

    Properties

    isArvoViolationError: true

    An additional flag to determine if it is an Arvo specific violation error

    message: string
    metadata: Record<string, any> | null

    Additional structured data about the violation

    name: "ViolationError<Config>"

    The error name, formatted as ViolationError This helps with error identification in logs and stack traces

    stack?: string
    type: "Config"

    The specific type/category of the violation

    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