# Interface: Flow

Defined in: [packages/sdk/src/core/types.ts:336](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L336)

## Properties

### harness

> **harness**: [`HarnessDefinition`](https://plandalf.com/docs/packages/sdk/interfaces/HarnessDefinition)

Defined in: [packages/sdk/src/core/types.ts:339](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L339)

***

### id

> **id**: `string`

Defined in: [packages/sdk/src/core/types.ts:337](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L337)

***

### state

> **state**: [`FlowState`](https://plandalf.com/docs/packages/sdk/interfaces/FlowState)

Defined in: [packages/sdk/src/core/types.ts:340](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L340)

***

### template

> **template**: [`FlowTemplate`](https://plandalf.com/docs/packages/sdk/interfaces/FlowTemplate)

Defined in: [packages/sdk/src/core/types.ts:338](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L338)

## Methods

### cancel()

> **cancel**(`reason?`): `void`

Defined in: [packages/sdk/src/core/types.ts:354](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L354)

#### Parameters

##### reason?

`string`

#### Returns

`void`

***

### close()

> **close**(): `void`

Defined in: [packages/sdk/src/core/types.ts:364](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L364)

#### Returns

`void`

***

### complete()

> **complete**(): `Promise`\<[`FlowResult`](https://plandalf.com/docs/packages/sdk/interfaces/FlowResult)\>

Defined in: [packages/sdk/src/core/types.ts:353](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L353)

#### Returns

`Promise`\<[`FlowResult`](https://plandalf.com/docs/packages/sdk/interfaces/FlowResult)\>

***

### completeStep()

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

Defined in: [packages/sdk/src/core/types.ts:348](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L348)

#### Parameters

##### stepId

`string`

##### data?

`unknown`

#### Returns

`Promise`\<`void`\>

***

### emit()

> **emit**\<`T`\>(`event`, `data`): `void`

Defined in: [packages/sdk/src/core/types.ts:359](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L359)

#### Type Parameters

##### T

`T` = `unknown`

#### Parameters

##### event

[`FlowEventType`](https://plandalf.com/docs/packages/sdk/type-aliases/FlowEventType)

##### data

`T`

#### Returns

`void`

***

### enterStep()

> **enterStep**(`stepId`): `Promise`\<`void`\>

Defined in: [packages/sdk/src/core/types.ts:347](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L347)

#### Parameters

##### stepId

`string`

#### Returns

`Promise`\<`void`\>

***

### getContext()

> **getContext**\<`T`\>(`key`): `T` \| `undefined`

Defined in: [packages/sdk/src/core/types.ts:343](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L343)

#### Type Parameters

##### T

`T` = `unknown`

#### Parameters

##### key

`string`

#### Returns

`T` \| `undefined`

***

### getNextStep()

> **getNextStep**(`currentStepId`): [`StepDefinition`](https://plandalf.com/docs/packages/sdk/interfaces/StepDefinition) \| `null`

Defined in: [packages/sdk/src/core/types.ts:350](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L350)

#### Parameters

##### currentStepId

`string`

#### Returns

[`StepDefinition`](https://plandalf.com/docs/packages/sdk/interfaces/StepDefinition) \| `null`

***

### mount()

> **mount**(`selector`, `options?`): `void`

Defined in: [packages/sdk/src/core/types.ts:362](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L362)

#### Parameters

##### selector

`string`

##### options?

###### frame?

`Partial`\<[`FrameConfig`](https://plandalf.com/docs/packages/sdk/interfaces/FrameConfig)\>

#### Returns

`void`

***

### off()

> **off**(`event`, `callback`): `void`

Defined in: [packages/sdk/src/core/types.ts:358](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L358)

#### Parameters

##### event

[`FlowEventType`](https://plandalf.com/docs/packages/sdk/type-aliases/FlowEventType)

##### callback

[`EventCallback`](https://plandalf.com/docs/packages/sdk/type-aliases/EventCallback)

#### Returns

`void`

***

### on()

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

Defined in: [packages/sdk/src/core/types.ts:357](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L357)

#### Type Parameters

##### T

`T` = `unknown`

#### Parameters

##### event

[`FlowEventType`](https://plandalf.com/docs/packages/sdk/type-aliases/FlowEventType)

##### callback

[`EventCallback`](https://plandalf.com/docs/packages/sdk/type-aliases/EventCallback)\<`T`\>

#### Returns

() => `void`

***

### setContext()

> **setContext**(`key`, `value`): `void`

Defined in: [packages/sdk/src/core/types.ts:344](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L344)

#### Parameters

##### key

`string`

##### value

`unknown`

#### Returns

`void`

***

### skipStep()

> **skipStep**(`stepId`): `void`

Defined in: [packages/sdk/src/core/types.ts:349](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L349)

#### Parameters

##### stepId

`string`

#### Returns

`void`

***

### unmount()

> **unmount**(): `void`

Defined in: [packages/sdk/src/core/types.ts:363](https://github.com/plandalf/numi/blob/fc6f42b5ade3d63b71623934838a6509f17203e2/packages/sdk/src/core/types.ts#L363)

#### Returns

`void`

Source: https://plandalf.com/docs/packages/sdk/interfaces/Flow