## Functions

<dl>
<dt><a href="#vrkflowMutations">vrkflowMutations(mutations, onAppendSteps, onPrependSteps, onInsertSteps, onUpdateStep, onSetComplete, onSetCurrent, onSetCanJump, onRemoveStep, onCloseWorkflow, onStartWorkflow)</a></dt>
<dd><p>Creates new mutations object for a Vuex module</p>
</dd>
<dt><a href="#closeWorkflow">closeWorkflow(state)</a></dt>
<dd><p>set state.isActive property to false</p>
</dd>
<dt><a href="#startWorkflow">startWorkflow(state)</a></dt>
<dd><p>set state.isActive property to true</p>
</dd>
<dt><a href="#resetWorkflow">resetWorkflow(state)</a></dt>
<dd><p>empty the step collection</p>
</dd>
<dt><a href="#appendSteps">appendSteps(state)</a></dt>
<dd><p>Append one or more steps to the step collection</p>
</dd>
<dt><a href="#prependSteps">prependSteps(state)</a></dt>
<dd><p>Prepend one or more steps to the step collection</p>
</dd>
<dt><a href="#insertSteps">insertSteps(state)</a></dt>
<dd><p>Insert one or more steps into the collection</p>
</dd>
<dt><a href="#updateStep">updateStep(state)</a></dt>
<dd><p>Update an existing step</p>
</dd>
<dt><a href="#removeStep">removeStep(state)</a></dt>
<dd><p>Remove a step at the given index</p>
</dd>
<dt><a href="#setComplete">setComplete(state, index, complete)</a></dt>
<dd><p>Set the step at the given index either complete or not</p>
</dd>
<dt><a href="#setCurrent">setCurrent(state, index)</a></dt>
<dd><p>Set the step at the given index as current step</p>
</dd>
<dt><a href="#setCanJump">setCanJump(state)</a></dt>
<dd><p>Set the step at the given index either &quot;jumpable&quot; or not</p>
</dd>
</dl>

<a name="vrkflowMutations"></a>

## vrkflowMutations(mutations, onAppendSteps, onPrependSteps, onInsertSteps, onUpdateStep, onSetComplete, onSetCurrent, onSetCanJump, onRemoveStep, onCloseWorkflow, onStartWorkflow)
Creates new mutations object for a Vuex module

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| mutations | <code>Object</code> | The default mutations (will override generated mutations object) |
| onAppendSteps | <code>function</code> | appendSteps callback |
| onPrependSteps | <code>function</code> | prependSteps callback |
| onInsertSteps | <code>function</code> | insertSteps callback |
| onUpdateStep | <code>function</code> | updateStep callback |
| onSetComplete | <code>function</code> | setComplete callback |
| onSetCurrent | <code>function</code> | setCurrent callback |
| onSetCanJump | <code>function</code> | setCanJump callback |
| onRemoveStep | <code>function</code> | removeStep callback |
| onCloseWorkflow | <code>function</code> | closeWorkflow callback |
| onStartWorkflow | <code>function</code> | startWorkflow mutations callback |

<a name="closeWorkflow"></a>

## closeWorkflow(state)
set state.isActive property to false

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |

<a name="startWorkflow"></a>

## startWorkflow(state)
set state.isActive property to true

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |

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

## resetWorkflow(state)
empty the step collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |

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

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

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .stepsToAppend | <code>Array</code> | Steps to append |

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

## prependSteps(state)
Prepend one or more steps to the step collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .stepsToPrepend | <code>Array</code> | Steps to prepend |

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

## insertSteps(state)
Insert one or more steps into the collection

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .stepsToPrepend | <code>Array</code> | Step to insert |
| .index | <code>Number</code> | A valid index of the step collection |

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

## updateStep(state)
Update an existing step

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .stepToUpdate | <code>Array</code> | Step to update |
| .index | <code>Number</code> | A valid index of the step collection |

<a name="removeStep"></a>

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

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .stepToUpdate | <code>Array</code> | Step to update |
| .index | <code>Number</code> | A valid index of the step collection |

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

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

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| index | <code>Number</code> | The index object |
| complete | <code>Boolean</code> | The complete value |

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

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

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| index | <code>Number</code> | The index object |

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

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

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | Application state |
| ... | <code>Object</code> |  |
| .index | <code>Number</code> | The index object |
| .canJump | <code>Boolean</code> | The jumpable flag |