Type Alias Eventstate

Eventstate: {
    compensatedBy?: string;
    end?: End;
    exclusive?: boolean;
    name?: string;
    onEvents?: Onevents[];
    timeouts?: {
        actionExecTimeout?: ActionExecTimeout;
        eventTimeout?: EventTimeout;
        stateExecTimeout?: StateExecTimeout;
    };
    type?: "EVENT";
} & unknown

This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel

Type declaration

  • OptionalcompensatedBy?: string

    Unique Name of a workflow state which is responsible for compensation of this state

  • Optionalend?: End

    State end definition

  • Optionalexclusive?: boolean

    If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed

  • Optionalname?: string

    State name

  • OptionalonEvents?: Onevents[]

    Define the events to be consumed and optional actions to be performed

  • Optionaltimeouts?: {
        actionExecTimeout?: ActionExecTimeout;
        eventTimeout?: EventTimeout;
        stateExecTimeout?: StateExecTimeout;
    }

    State specific timeouts

    • OptionalactionExecTimeout?: ActionExecTimeout

      Action execution timeout duration (literal ISO 8601 duration format or expression which evaluation results in an ISO 8601 duration)

    • OptionaleventTimeout?: EventTimeout

      Timeout duration to wait for consuming defined events (literal ISO 8601 duration format or expression which evaluation results in an ISO 8601 duration)

    • OptionalstateExecTimeout?: StateExecTimeout

      Workflow state execution timeout duration (literal ISO 8601 duration format or expression which evaluation results in an ISO 8601 duration)

  • Optionaltype?: "EVENT"

    State type