FlowIntentions
@dopt/react / Exports / FlowIntentions
Interface: FlowIntentions
Methods corresponding to an intent-based API for signaling state transitions of a flow. These methods have side effects on ['state'] contained within the flow.
Table of contents
Properties
Properties
reset
• reset: () => undefined | void
Type declaration
▸ (): undefined | void
Resets the flow's state and all of its associated blocks and their state to the original/default state.
Modifies
Sets ['state']['exited'] to false Sets ['state']['completed'] to false Sets ['state']['started'] to false Sets all ['state']['active'] to false Sets all ['state']['completed'] to false
Returns
undefined | void
Defined in
packages/@dopt/react/src/use-flow.ts:27
exit
• exit: () => undefined | void
Type declaration
▸ (): undefined | void
Exits the flow.
Modifies
Sets ['state']['exited'] to true Sets all ['state']['active'] to false
Returns
undefined | void
Defined in
packages/@dopt/react/src/use-flow.ts:35
complete
• complete: () => undefined | void
Type declaration
▸ (): undefined | void
Completes the flow, independent of a completed state that might be derived from its [].
Modifies
Sets ['state']['completed'] to true Sets all ['state']['active'] to false
Returns
undefined | void