Interface: IStep

Table of contents

Properties

• data

Methods

• clear
• complete
• getState
• isCompleted
• isStarted
• on
• start

Properties

data

• data: StepData

Methods

clear

▸ clear(metadata?): IStep

Parameters

Name	Type
metadata?	Record<string, any>

Returns

IStep

---

complete

▸ complete(metadata?): IStep

Parameters

Name	Type
metadata?	Record<string, any>

Returns

IStep

---

getState

▸ getState(): StepState

Returns

StepState

---

isCompleted

▸ isCompleted(): boolean

Returns

boolean

---

isStarted

▸ isStarted(): boolean

Returns

boolean

---

on

▸ on(eventId, callback): void

Parameters

Name	Type
eventId	StepEventListeners
callback	StateChangeCallback

Returns

void

---

start

▸ start(metadata?): IStep

Parameters

Name	Type
metadata?	Record<string, any>

Returns

IStep