Class ArvoEventHandler<TContract>

constructor

• new ArvoEventHandler<TContract>(param): ArvoEventHandler<TContract>

• Type Parameters

  • TContract extends ArvoContract<string, string, Record<`${number}.${number}.${number}`, {
        accepts: ZodTypeAny;
        emits: Record<string, ZodTypeAny>;
    }>, Record<string, any>>

  Parameters

  • param: ArvoEventHandlerParam<TContract>

  Returns ArvoEventHandler<TContract>

Readonlycontract

Readonlyexecutionunits

Readonlyhandler

ReadonlyspanOptions

Optional ReadonlysystemErrorDomain

domain

• get domain(): null | string

• The contract-defined domain for the handler

  Returns null | string

source

• get source(): TContract["type"]

• The source identifier for events produced by this handler

  Returns TContract["type"]

systemErrorSchema

• get systemErrorSchema(): {
      domain: undefined | (null | string)[];
      schema: ZodObject<{
          errorMessage: ZodString;
          errorName: ZodString;
          errorStack: ZodNullable<ZodString>;
      }, "strip", ZodTypeAny, {
          errorMessage: string;
          errorName: string;
          errorStack: null | string;
      }, {
          errorMessage: string;
          errorName: string;
          errorStack: null | string;
      }>;
      type: `sys.${string}.error`;
  }

• Provides access to the system error event schema configuration.

  Returns {
      domain: undefined | (null | string)[];
      schema: ZodObject<{
          errorMessage: ZodString;
          errorName: ZodString;
          errorStack: ZodNullable<ZodString>;
      }, "strip", ZodTypeAny, {
          errorMessage: string;
          errorName: string;
          errorStack: null | string;
      }, {
          errorMessage: string;
          errorName: string;
          errorStack: null | string;
      }>;
      type: `sys.${string}.error`;
  }

  • domain: undefined | (null | string)[]

  • schema: ZodObject<{
        errorMessage: ZodString;
        errorName: ZodString;
        errorStack: ZodNullable<ZodString>;
    }, "strip", ZodTypeAny, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }, {
        errorMessage: string;
        errorName: string;
        errorStack: null | string;
    }>

    The Zod schema used for validating data associated with this record

  • type: `sys.${string}.error`

    The type identifier for this record

execute

• execute(event, opentelemetry?): Promise<{
      events: ArvoEvent<Record<string, any>, Record<string,
          | null
          | string
          | number
          | boolean>, string>[];
  }>

• Processes an incoming event according to the handler's contract specifications. This method handles the complete lifecycle of event processing including validation, execution, error handling, and multi-domain event broadcasting, while maintaining detailed telemetry through OpenTelemetry.

  Parameters

  • event: ArvoEvent<Record<string, any>, Record<string,
        | null
        | string
        | number
        | boolean>, string>
  • Optionalopentelemetry: ArvoEventHandlerOpenTelemetryOptions

  Returns Promise<{
      events: ArvoEvent<Record<string, any>, Record<string,
          | null
          | string
          | number
          | boolean>, string>[];
  }>

  Throws

  when input or output event data violates the contract schema, or when event emission fails due to invalid data

  Throws

  when event type doesn't match contract type, when the contract version expected by the event does not exist in handler configuration, or when contract URI mismatch occurs

  Throws

  for explicitly handled runtime errors that should bubble up