Interface Flow<StartInput>

Defines one durable application Flow and its registered API surface.

interface Flow<StartInput = void> {
    getFlowType(): string;
    getPersistenceSchema?(): PersistenceSchema;
    getSteps(): StepList<StartInput>;
    handleTimeout?(context: AsyncContext): StepDecision | Promise<StepDecision>;
}

Type Parameters

StartInput = void
Value accepted by the optional starting Step.

Index

Methods

getFlowType getPersistenceSchema? getSteps handleTimeout?

Methods

getFlowType

getFlowType(): string
Returns the protocol Flow type.

Returns string
A non-empty Flow type unique within the Registry.

`Optional`getPersistenceSchema

getPersistenceSchema?(): PersistenceSchema
Returns this Flow's persistence definitions.

Returns PersistenceSchema
Attributes and Channels owned by this Flow. Flows without this method have none.

getSteps

getSteps(): StepList<StartInput>
Returns this Flow's Step definitions.

Returns StepList<StartInput>
Zero or one starting Step plus all other registered Steps.

`Optional`handleTimeout

handleTimeout?(context: AsyncContext): StepDecision | Promise<StepDecision>
Handles expiration of this Flow's durable soft-timeout timer.

When present, a positive timeout defaults to the handler policy. Dex awaits the result and applies it with normal Step Execute validation. One logical invocation may include retry attempts configured by FlowTimeoutHandlerOptions. The hook may transition, dead-end, complete, fail, or request graceful completion.
Parameters
- context: AsyncContext
  Timeout invocation Context; it must not be retained.
Returns StepDecision | Promise<StepDecision>
A StepDecision, synchronously or asynchronously.