## Functions

<dl>
<dt><a href="#vrkflowActions">vrkflowActions(actions)</a></dt>
<dd><p>Creates new actions object for a Vuex module.</p>
</dd>
<dt><a href="#resetWorkflow">resetWorkflow()</a></dt>
<dd><p>Reset all the steps and set the first one as current.</p>
</dd>
<dt><a href="#closeWorkflow">closeWorkflow()</a></dt>
<dd><p>Set the isActive state&#39;s flag to false</p>
</dd>
<dt><a href="#startWorkflow">startWorkflow()</a></dt>
<dd><p>Set the isActive stats&#39;s flag to true</p>
</dd>
<dt><a href="#nextStept">nextStept()</a></dt>
<dd><p>Set the next step as the current step</p>
</dd>
<dt><a href="#previousStep">previousStep()</a></dt>
<dd><p>Set the previous step as the current step</p>
</dd>
<dt><a href="#jumpToStep">jumpToStep(step)</a></dt>
<dd><p>Set the given step as the current step</p>
</dd>
<dt><a href="#getStep">getStep(index)</a> ⇒ <code>Object</code></dt>
<dd><p>Returns the step corresponding to the given index</p>
</dd>
<dt><a href="#getPreviousStep">getPreviousStep()</a> ⇒ <code>Object</code></dt>
<dd><p>Returns the previous step</p>
</dd>
<dt><a href="#getNextStep">getNextStep()</a> ⇒ <code>Object</code></dt>
<dd><p>Returns the next step</p>
</dd>
<dt><a href="#removeStep">removeStep(index)</a></dt>
<dd><p>Remove a step at the given index</p>
</dd>
<dt><a href="#setComplete">setComplete(index)</a></dt>
<dd><p>Set the step at the given index either complete or not</p>
</dd>
<dt><a href="#setCurrent">setCurrent(index)</a></dt>
<dd><p>Set the step at the given index either as current step</p>
</dd>
<dt><a href="#setCanJump">setCanJump(index)</a></dt>
<dd><p>Set the step at the given index either &quot;jumpable&quot; or not</p>
</dd>
<dt><a href="#updateStep">updateStep(index, stepToUpdate)</a></dt>
<dd><p>Update an existing step</p>
</dd>
<dt><a href="#appendSteps">appendSteps(stepToAppend)</a></dt>
<dd><p>Append one or more steps to the steps collection</p>
</dd>
<dt><a href="#prependSteps">prependSteps(stepToPrepend)</a></dt>
<dd><p>Add one or more steps at the beginning of the step collection</p>
</dd>
<dt><a href="#insertSteps">insertSteps(stepToInsert, index)</a></dt>
<dd><p>Insert one or more steps at the given index of the step collection</p>
</dd>
</dl>

<a name="vrkflowActions"></a>

## vrkflowActions(actions)
Creates new actions object for a Vuex module.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| actions | <code>Object</code> | The default actions (will override generated actions object). |

<a name="resetWorkflow"></a>

## resetWorkflow()
Reset all the steps and set the first one as current.

**Kind**: global function  
<a name="closeWorkflow"></a>

## closeWorkflow()
Set the isActive state's flag to false

**Kind**: global function  
<a name="startWorkflow"></a>

## startWorkflow()
Set the isActive stats's flag to true

**Kind**: global function  
<a name="nextStept"></a>

## nextStept()
Set the next step as the current step

**Kind**: global function  
<a name="previousStep"></a>

## previousStep()
Set the previous step as the current step

**Kind**: global function  
<a name="jumpToStep"></a>

## jumpToStep(step)
Set the given step as the current step

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| step | <code>Object</code> | Target step |
| step.canJump | <code>Boolean</code> | Flag which allows to jump to the target step |

<a name="getStep"></a>

## getStep(index) ⇒ <code>Object</code>
Returns the step corresponding to the given index

**Kind**: global function  
**Returns**: <code>Object</code> - The step at the given index  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | Step's index |

<a name="getPreviousStep"></a>

## getPreviousStep() ⇒ <code>Object</code>
Returns the previous step

**Kind**: global function  
**Returns**: <code>Object</code> - The previous step  
<a name="getNextStep"></a>

## getNextStep() ⇒ <code>Object</code>
Returns the next step

**Kind**: global function  
**Returns**: <code>Object</code> - The next step  
<a name="removeStep"></a>

## removeStep(index)
Remove a step at the given index

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | The index object |

<a name="setComplete"></a>

## setComplete(index)
Set the step at the given index either complete or not

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | The index object |

<a name="setCurrent"></a>

## setCurrent(index)
Set the step at the given index either as current step

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | The index object |

<a name="setCanJump"></a>

## setCanJump(index)
Set the step at the given index either "jumpable" or not

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | The index object |

<a name="updateStep"></a>

## updateStep(index, stepToUpdate)
Update an existing step

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| index | <code>Number</code> | The index of the step to update |
| stepToUpdate | <code>Object</code> | The step object that will be merged with the step to update |

<a name="appendSteps"></a>

## appendSteps(stepToAppend)
Append one or more steps to the steps collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| stepToAppend | <code>Array</code> | An array of step objects |

<a name="prependSteps"></a>

## prependSteps(stepToPrepend)
Add one or more steps at the beginning of the step collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| stepToPrepend | <code>Array</code> | An array of step objects |

<a name="insertSteps"></a>

## insertSteps(stepToInsert, index)
Insert one or more steps at the given index of the step collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| stepToInsert | <code>Array</code> | An array of step objects |
| index | <code>Array</code> | A valid index of the step collection |