[gs-longan](../README.md) / StepFlow

# Class: StepFlow

## Table of contents

### Constructors

- [constructor](StepFlow.md#constructor)

### Properties

- [\_currentStep](StepFlow.md#_currentstep)
- [command](StepFlow.md#command)
- [commandText](StepFlow.md#commandtext)
- [endStep](StepFlow.md#endstep)
- [startStep](StepFlow.md#startstep)
- [stepChanged](StepFlow.md#stepchanged)
- [stepList](StepFlow.md#steplist)

### Accessors

- [currentStep](StepFlow.md#currentstep)

### Methods

- [end](StepFlow.md#end)
- [execute](StepFlow.md#execute)
- [moveTo](StepFlow.md#moveto)
- [moveToEnd](StepFlow.md#movetoend)
- [moveToStart](StepFlow.md#movetostart)
- [next](StepFlow.md#next)
- [processButtons](StepFlow.md#processbuttons)
- [processTextInput](StepFlow.md#processtextinput)
- [set](StepFlow.md#set)
- [start](StepFlow.md#start)
- [step](StepFlow.md#step)

## Constructors

### constructor

• **new StepFlow**(`command`): [`StepFlow`](StepFlow.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `command` | [`Command`](Command.md) |

#### Returns

[`StepFlow`](StepFlow.md)

## Properties

### \_currentStep

• **\_currentStep**: [`CommandStep`](CommandStep.md)

___

### command

• **command**: [`Command`](Command.md)

___

### commandText

• **commandText**: `string`

___

### endStep

• **endStep**: [`CommandStep`](CommandStep.md)

___

### startStep

• **startStep**: [`CommandStep`](CommandStep.md)

___

### stepChanged

• **stepChanged**: [`List`](List.md)\<(`stepFlow`: [`StepFlow`](StepFlow.md)) => `void`\>

___

### stepList

• **stepList**: [`List`](List.md)\<[`CommandStep`](CommandStep.md)\>

## Accessors

### currentStep

• `get` **currentStep**(): [`CommandStep`](CommandStep.md)

#### Returns

[`CommandStep`](CommandStep.md)

• `set` **currentStep**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [`CommandStep`](CommandStep.md) |

#### Returns

`void`

## Methods

### end

▸ **end**(): [`CommandStep`](CommandStep.md)

#### Returns

[`CommandStep`](CommandStep.md)

___

### execute

▸ **execute**(): `void`

#### Returns

`void`

___

### moveTo

▸ **moveTo**(`index`): [`StatePack`](StatePack.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `index` | `string` \| `number` |

#### Returns

[`StatePack`](StatePack.md)

___

### moveToEnd

▸ **moveToEnd**(): `void`

#### Returns

`void`

___

### moveToStart

▸ **moveToStart**(): `void`

#### Returns

`void`

___

### next

▸ **next**(): [`StatePack`](StatePack.md)

#### Returns

[`StatePack`](StatePack.md)

___

### processButtons

▸ **processButtons**(`text`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `text` | `string` |

#### Returns

`void`

___

### processTextInput

▸ **processTextInput**(`text`): `string`

#### Parameters

| Name | Type |
| :------ | :------ |
| `text` | `string` |

#### Returns

`string`

___

### set

▸ **set**(`commandStep`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `commandStep` | [`CommandStep`](CommandStep.md) |

#### Returns

`void`

___

### start

▸ **start**(): [`CommandStep`](CommandStep.md)

#### Returns

[`CommandStep`](CommandStep.md)

___

### step

▸ **step**(`condition`): [`CommandStep`](CommandStep.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `condition` | `any` |

#### Returns

[`CommandStep`](CommandStep.md)