Dex TypeScript SDK 1.28.1
    Preparing search index...

    Class StepRef

    Addresses a registered Step by its stable Step type without an implementation.

    Use with goTo, StepMovement, failure routing, or cancellation. References cannot execute or appear in a StepList. Registry validates execute-failure routes declared by getStepOptions. Client validates timeout-handler failure routes when it maps start options. A StepRef returned from a handler, in a movement or cancellation selection, is validated only when the Worker applies that returned result. The constructor never checks that the Step type exists. Invalid declarations raise FlowDefinitionError. Invalid handler targets are reported as InvalidStepResultError. The destination codec validates input at runtime.

    const movement = StepMovement.of(new StepRef("Charge"), { orderId: "42" });
    
    Index

    Constructors

    Properties

    Constructors

    • Creates a reference to a Step type registered in the containing Flow.

      Parameters

      • stepType: string

        Non-empty type returned by the destination's getStepType.

      Returns StepRef

      TypeError If stepType is empty or whitespace-only.

    Properties

    stepType: string

    Stable destination Step type.