@runloop/agent-axon-client
    Preparing search index...

    Class SystemError

    Error thrown when the system reports a fatal error (e.g. agent binary not found, process crash).

    Includes metadata from the originating Axon event for logging, telemetry, and programmatic error handling.

    Hierarchy

    • Error
      • SystemError
    Index

    Other

    axonId: string | undefined

    The Axon ID where the error occurred, if available.

    cause?: unknown
    eventType: string

    The Axon event type that triggered this error (e.g. "broker.error").

    message: string
    name: string
    sequence: number | undefined

    The sequence number of the event in the Axon stream, if available.

    stack?: string
    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.

    • 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

    Factory

    • Creates a SystemError from an Axon event.

      Parameters

      • event: { axon_id?: string; event_type: string; payload: string; sequence?: number }

        The Axon event containing the error payload and metadata.

      • Optionaloptions: ErrorOptions

        Optional ErrorOptions for cause chaining.

      Returns SystemError

      A new SystemError with message and metadata extracted from the event.