Type alias CloudOrchestrationActorOptions<TLogic>

CloudOrchestrationActorOptions<TLogic>: ActorOptions<TLogic> & {
    id: string;
    inspect?: ((evt) => void);
    middleware?: CloudOrchestrationMiddlewares;
    name: string;
    version: Version;
}

Configuration options tailored for a CloudOrchestrationActor, extending the base ActorOptions with cloud-specific features. These options provide enhanced capabilities for inspection event handling and middleware integration, making the actor well-suited for cloud-based scenarios.

Type Parameters

  • TLogic extends AnyActorLogic

Type declaration

  • id: string

    Unique identifier for the orchestrator actor, crucial for tracking and managing the state of each orchestration instance. This ID differentiates between multiple instances and serves as a key component in orchestrating cloud-based processes.

  • Optional inspect?: ((evt) => void)

    An optional callback function to handle inspection events. This function is useful for debugging, monitoring, or applying custom processing to inspection events, thereby improving the actor's observability.

    Param: evt

    The inspection event to be handled.

      • (evt): void

      • An optional callback function to handle inspection events. This function is useful for debugging, monitoring, or applying custom processing to inspection events, thereby improving the actor's observability.

        Parameters

        • evt: InspectionEvent

          The inspection event to be handled.

        Returns void

  • Optional middleware?: CloudOrchestrationMiddlewares

    An optional object specifying middleware for use with the actor. This middleware enables customized handling of cloud events and orchestration logic, facilitating the implementation of intricate scenarios in cloud-based applications.

  • name: string

    The orchestrator's project-wide unique name, such as "SummaryStateMachine". This name provides a distinctive identifier for the orchestrator within the project context.

  • version: Version

    The version of the state machine responsible for orchestration. Must be in the format {number}.{number}.{number}, set by the developer to denote the state machine version.

Generated using TypeDoc