Interface: FlowBreakEvent

Defined in: node_modules/footprintjs/dist/types/lib/engine/narrative/types.d.ts:239

Event passed to FlowRecorder.onBreak.

Properties

propagatedFromSubflow?

optional propagatedFromSubflow?: string

Defined in: node_modules/footprintjs/dist/types/lib/engine/narrative/types.d.ts:255

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?

optional reason?: string

Defined in: node_modules/footprintjs/dist/types/lib/engine/narrative/types.d.ts:248

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.

---

stageName

stageName: string

Defined in: node_modules/footprintjs/dist/types/lib/engine/narrative/types.d.ts:240

---

traversalContext?

optional traversalContext?: TraversalContext

Defined in: node_modules/footprintjs/dist/types/lib/engine/narrative/types.d.ts:241