Type alias OrchestrationMachineConfigV3<TContext, TInput>

OrchestrationMachineConfigV3<TContext, TInput>: {
    context?: ((params) => TContext);
    description?: string;
    executionUnits?: number;
    id: string;
    initial?: string;
    states: Record<string, OrchestrationStateConfigV3<TContext>>;
    type?: Exclude<OrchestrationStateType, "final">;
}

Represents the configuration schema for an orchestration state machine, encompassing states, transitions, actions, and the context within which these states operate.

Attributes:

  • id: A unique identifier for the orchestration machine, crucial for distinguishing between different machines.
  • description: An optional detailed description of the orchestration machine's purpose and its functional scope.
  • context: A function or static object that defines the initial state context, either generated statically or dynamically based on input data.
  • initial: The initial state identifier the machine will enter upon instantiation, required unless the type is 'parallel'.
  • type: The type of state machine, such as 'parallel', affecting how states are managed and executed.
  • states: A mapping of state identifiers to their configurations, detailing behavior and structural relationships.

Type Parameters

  • TContext extends Record<string, any>

  • TInput extends Record<string, any> = Record<string, any>

Type declaration

Typeparam

TContext Describes the type of the state context, encapsulating the structure and data within each state.

Typeparam

TInput Defines the type of input data that influences or initializes the state context.

Generated using TypeDoc