Interface: Flow

Defined in: packages/sdk/src/core/types.ts:336

Properties

harness

harness: HarnessDefinition

Defined in: packages/sdk/src/core/types.ts:339

id

id: string

Defined in: packages/sdk/src/core/types.ts:337

state

state: FlowState

Defined in: packages/sdk/src/core/types.ts:340

template

template: FlowTemplate

Defined in: packages/sdk/src/core/types.ts:338

Methods

cancel()

cancel(reason?): void

Defined in: packages/sdk/src/core/types.ts:354

Parameters

reason?

string

Returns

void

close()

close(): void

Defined in: packages/sdk/src/core/types.ts:364

Returns

void

complete()

complete(): Promise<FlowResult>

Defined in: packages/sdk/src/core/types.ts:353

Returns

Promise<FlowResult>

completeStep()

completeStep(stepId, data?): Promise<void>

Defined in: packages/sdk/src/core/types.ts:348

Parameters

stepId

string

data?

unknown

Returns

Promise<void>

emit()

emit<T>(event, data): void

Defined in: packages/sdk/src/core/types.ts:359

Type Parameters

T

T = unknown

Parameters

event

FlowEventType

data

T

Returns

void

enterStep()

enterStep(stepId): Promise<void>

Defined in: packages/sdk/src/core/types.ts:347

Parameters

stepId

string

Returns

Promise<void>

getContext()

getContext<T>(key): T | undefined

Defined in: packages/sdk/src/core/types.ts:343

Type Parameters

T

T = unknown

Parameters

key

string

Returns

T | undefined

getNextStep()

getNextStep(currentStepId): StepDefinition | null

Defined in: packages/sdk/src/core/types.ts:350

Parameters

currentStepId

string

Returns

StepDefinition | null

mount()

mount(selector, options?): void

Defined in: packages/sdk/src/core/types.ts:362

Parameters

selector

string

options?

frame?

Partial<FrameConfig>

Returns

void

off()

off(event, callback): void

Defined in: packages/sdk/src/core/types.ts:358

Parameters

event

FlowEventType

callback

EventCallback

Returns

void

on()

on<T>(event, callback): () => void

Defined in: packages/sdk/src/core/types.ts:357

Type Parameters

T

T = unknown

Parameters

event

FlowEventType

callback

EventCallback<T>

Returns

() => void

setContext()

setContext(key, value): void

Defined in: packages/sdk/src/core/types.ts:344

Parameters

key

string

value

unknown

Returns

void

skipStep()

skipStep(stepId): void

Defined in: packages/sdk/src/core/types.ts:349

Parameters

stepId

string

Returns

void

unmount()

unmount(): void

Defined in: packages/sdk/src/core/types.ts:363

Returns

void