arvo-event-handler
    Preparing search index...

    Type Alias ArvoOrchestratorParam

    Configuration parameters for ArvoOrchestrator constructor.

    Defines all required components and settings for orchestrator initialization. For simplified creation with default components, use createArvoOrchestrator.

    type ArvoOrchestratorParam = {
        defaultEventEmissionDomains?: {
            complete?: NonEmptyArray<string | null>;
            services?: NonEmptyArray<string | null>;
            systemError?: NonEmptyArray<string | null>;
        };
        executionEngine: IMachineExectionEngine;
        executionunits?: number;
        memory: IMachineMemory<MachineMemoryRecord>;
        registry: IMachineRegistry;
        requiresResourceLocking: boolean;
        spanOptions?: ArvoEventHandlerOtelSpanOptions;
    }
    Index

    Properties

    defaultEventEmissionDomains? executionEngine executionunits? memory registry requiresResourceLocking spanOptions?

    Properties

    defaultEventEmissionDomains?: {
        complete?: NonEmptyArray<string | null>;
        services?: NonEmptyArray<string | null>;
        systemError?: NonEmptyArray<string | null>;
    }

    Optional default domains for the events emitted by the orchestrator.

    Type Declaration

    • Optionalcomplete?: NonEmptyArray<string | null>

      Defauld domain for the final completion event emitted by this orchestrator

      Completion event is routed through these domains when the orchestrator successfully processes an init event. The machine 'output' transform function implementations can override this default.

      [ArvoDomain.ORCHESTRATION_CONTEXT]
    • Optionalservices?: NonEmptyArray<string | null>

      Default domains for service events emitted by this orchestrator.

      The service xstate.emit function can over-ride this default.

      [ArvoDomain.LOCAL]
    • OptionalsystemError?: NonEmptyArray<string | null>

      Default domains for system error events emitted by this orchestrator.

      System errors are routed through these domains when the handler encounters unhandled exceptions or critical failures.

      [ArvoDomain.ORCHESTRATION_CONTEXT]
    executionEngine: IMachineExectionEngine

    Engine responsible for executing state machine logic

    executionunits?: number

    Computational cost metric assigned to orchestrator operations

    memory: IMachineMemory<MachineMemoryRecord>

    Memory interface for state persistence and retrieval

    registry: IMachineRegistry

    Registry for managing and resolving machine instances

    requiresResourceLocking: boolean

    Whether to enforce resource locking for concurrent safety

    spanOptions?: ArvoEventHandlerOtelSpanOptions

    OpenTelemetry span configuration for distributed tracing

    Settings

    Member Visibility

    On This Page

    Properties