footprintjs - v11.2.0
    Preparing search index...

    Interface FlowBreakEvent

    Event passed to FlowRecorder.onBreak.

    interface FlowBreakEvent {
        propagatedFromSubflow?: string;
        reason?: string;
        stageName: string;
        traversalContext?: TraversalContext;
    }
    Index
    propagatedFromSubflow?: string

    When true, this break event was raised on the PARENT because an inner subflow's break propagated up (via SubflowMountOptions.propagateBreak). The originating inner break fires its own onBreak event separately — this flag lets recorders distinguish the two.

    reason?: string

    Optional free-form reason supplied by scope.$break(reason). Absent when the stage invoked $break() without an argument. Propagates when a subflow is mounted with propagateBreak: true — the outer break event carries the inner break's reason too. Under a redaction policy it is the placeholder when the stage read a selected value, its args hold a selected key, or logs.breakReason is selected by name.

    stageName: string
    traversalContext?: TraversalContext