Interface: IFlow

Table of contents

Properties

• data
• steps

Methods

• clear
• complete
• getData
• getState
• isCompleted
• isStarted
• on
• step

Properties

data

• data: FlowData

---

steps

• steps: Map<string, IStep>

Methods

clear

▸ clear(clearStepsToo?): IFlow

Parameters

Name	Type
clearStepsToo?	boolean

Returns

IFlow

---

complete

▸ complete(): Promise<void>

Returns

Promise<void>

---

getData

▸ getData(): FlowData

Returns

FlowData

---

getState

▸ getState(): FlowState

Returns

FlowState

---

isCompleted

▸ isCompleted(): boolean

Returns

boolean

---

isStarted

▸ isStarted(): boolean

Returns

boolean

---

on

▸ on(eventId, callback): void

Parameters

Name	Type
eventId	StepEventListeners
callback	StateChangeCallback

Returns

void

---

step

▸ step(stepId): IStep

Parameters

Name	Type
stepId	string

Returns

IStep