Flow
Interface: Flow
Table of contents
Properties
Methods
Properties
type
• type: Ref<"flow">
Defined in
packages/@dopt/vue/src/flow.ts:6
kind
• kind: Ref<"flow">
Defined in
packages/@dopt/vue/src/flow.ts:7
uid
• uid: Ref<string>
Defined in
packages/@dopt/vue/src/flow.ts:8
sid
• sid: Ref<string>
Defined in
packages/@dopt/vue/src/flow.ts:9
version
• version: Ref<number>
Defined in
packages/@dopt/vue/src/flow.ts:10
state
• state: Ref<{ stopped: boolean ; started: boolean ; finished: boolean }>
The up-to-date state of this Flow.
Defined in
packages/@dopt/vue/src/flow.ts:14
Methods
start
▸ start(options?): void
Start this flow. Will also update the state of blocks within this flow, as appropriate.
Remarks
This function will update state with Dopt and trigger changes. Subscribe to the flows and blocks you care about to react to those changes.
Parameters
| Name | Type |
|---|---|
options? | Object |
options.force? | boolean |
Returns
void
void
Defined in
packages/@dopt/vue/src/flow.ts:29
▸ start(): void
Returns
void
Defined in
packages/@dopt/vue/src/flow.ts:30
finish
▸ finish(): void
Finish this flow. Will also update the state of blocks within this flow, as appropriate.
Remarks
This function will update state with Dopt and trigger changes. Subscribe to the flows and blocks you care about to react to those changes.
Returns
void
void
Defined in
packages/@dopt/vue/src/flow.ts:41
stop
▸ stop(): void
Stop this flow. Will also update the state of blocks within this flow, as appropriate.
Remarks
This function will update state with Dopt and trigger changes. Subscribe to the flows and blocks you care about to react to those changes.
Returns
void
void
Defined in
packages/@dopt/vue/src/flow.ts:52
reset
▸ reset(options?): void
Reset this flow. Will also update the state of blocks within this flow, as appropriate. Under the hood, this method sets flows and blocks to their original/default states and subsequently calls start.
Remarks
This function will update state with Dopt and trigger changes. Subscribe to the flows and blocks you care about to react to those changes.
Parameters
| Name | Type |
|---|---|
options? | Object |
options.force? | boolean |
Returns
void
void
Defined in
packages/@dopt/vue/src/flow.ts:70
▸ reset(): void
Returns
void