Class ContractViolation

ContractViolation indicates a critical mismatch between services where event data violates the receiving handler's contract. This represents a serious system issue where services are out of sync with their contracts. Common causes include:

  • Upstream services sending malformed data
  • Breaking changes in contracts without proper version management
  • Implicit assumptions in handlers not covered by contracts

Requires explicit handling as it signals potential system-wide contract violations.

Hierarchy

  • ViolationError<"Contract">
    • ContractViolation

Constructors

constructor

Properties

isArvoViolationError message metadata name stack? type prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

Properties

ReadonlyisArvoViolationError

isArvoViolationError = true

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

message

message: string

Readonlymetadata

metadata: null | Record<string, any>

Additional structured data about the violation

Readonlyname

name

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

Optionalstack

stack?: string

Readonlytype

type

The specific type/category of the violation

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods