a Choice chain
core of cli-chain
a wrapper for Vorpal
a Question chain
a Stepper chain
a Stepper persisting chain
a Step chain
entry point
ChainedMapStepChildadd a step, which is a new Question
StepsFrommodule:flipchain/ChainedMap, module:fliplog
* [Choice.js](#Choice.module_js)
* [~Choice](#Choice.module_js..Choice) : ChainedMap
* [new Choice()](#new_Choice.module_js..Choice_new)
* [.when(fn)](#Choice.module_js..Choice+when) ⇒ Choice
* [.value(value)](#Choice.module_js..Choice+value) ⇒ Choice
* [.name(name)](#Choice.module_js..Choice+name) ⇒ Choice
* [.toConfig()](#Choice.module_js..Choice+toConfig) ⇒ Object
### Choice.js~Choice : ChainedMap
**Kind**: inner class of [Choice.js](#Choice.module_js)
* [~Choice](#Choice.module_js..Choice) : ChainedMap
* [new Choice()](#new_Choice.module_js..Choice_new)
* [.when(fn)](#Choice.module_js..Choice+when) ⇒ Choice
* [.value(value)](#Choice.module_js..Choice+value) ⇒ Choice
* [.name(name)](#Choice.module_js..Choice+name) ⇒ Choice
* [.toConfig()](#Choice.module_js..Choice+toConfig) ⇒ Object
#### new Choice()
a choice used in Question
#### choice.when(fn) ⇒ Choice
enable a step when a callback returns true
**Kind**: instance method of [Choice](#Choice.module_js..Choice)
**Returns**: Choice - @chainable
| Param | Type | Description |
| --- | --- | --- |
| fn | function | function that is bound to answers |
#### choice.value(value) ⇒ Choice
**Kind**: instance method of [Choice](#Choice.module_js..Choice)
**Returns**: Choice - @chainable
| Param | Type | Description |
| --- | --- | --- |
| value | \* | value of a choice |
#### choice.name(name) ⇒ Choice
**Kind**: instance method of [Choice](#Choice.module_js..Choice)
**Returns**: Choice - @chainable
| Param | Type | Description |
| --- | --- | --- |
| name | string | decorates the name and the value to use . syntax |
#### choice.toConfig() ⇒ Object
**Kind**: instance method of [Choice](#Choice.module_js..Choice)
## Core.js
core of cli-chain
**Requires**: module:flipchain/ChainedMap, module:flipchain/ChainedSet, module:fliplog, module:./Steps, module:./Program, module:./Question, module:./Choice
* [Core.js](#Core.module_js)
* [~Core](#Core.module_js..Core) : ChainedMap
* [new Core([parent])](#new_Core.module_js..Core_new)
* _instance_
* [.handleParent([parent])](#Core.module_js..Core+handleParent)
* [.decorateCurrent()](#Core.module_js..Core+decorateCurrent) ⇒ Core
* [.program(...args)](#Core.module_js..Core+program) ⇒ Program
* [.onAnswers([cb])](#Core.module_js..Core+onAnswers) ⇒ Core
* [.then(cb)](#Core.module_js..Core+then) ⇒ Core
* [.run()](#Core.module_js..Core+run) ⇒ Promise
* [.child(name, type, [msg])](#Core.module_js..Core+child) ⇒ StepChild
* [.stepChild(name, [type], [msg])](#Core.module_js..Core+stepChild) ⇒ StepChild
* _static_
* [.program()](#Core.module_js..Core.program) ⇒ Core
* [.init([parent])](#Core.module_js..Core.init) ⇒ Core
### Core.js~Core : ChainedMap
**Kind**: inner class of [Core.js](#Core.module_js)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| answerCallbacks | ChainedSet.<string, function()> | callbacks to call for each answer |
| stepper | Stepper | steps through the steps 1 by 1 |
| answers | answers | from stepper.data, by reference |
| steps | Steps | steps to use in stepper |
| current | Question | last step accessed, for easier chaining |
* [~Core](#Core.module_js..Core) : ChainedMap
* [new Core([parent])](#new_Core.module_js..Core_new)
* _instance_
* [.handleParent([parent])](#Core.module_js..Core+handleParent)
* [.decorateCurrent()](#Core.module_js..Core+decorateCurrent) ⇒ Core
* [.program(...args)](#Core.module_js..Core+program) ⇒ Program
* [.onAnswers([cb])](#Core.module_js..Core+onAnswers) ⇒ Core
* [.then(cb)](#Core.module_js..Core+then) ⇒ Core
* [.run()](#Core.module_js..Core+run) ⇒ Promise
* [.child(name, type, [msg])](#Core.module_js..Core+child) ⇒ StepChild
* [.stepChild(name, [type], [msg])](#Core.module_js..Core+stepChild) ⇒ StepChild
* _static_
* [.program()](#Core.module_js..Core.program) ⇒ Core
* [.init([parent])](#Core.module_js..Core.init) ⇒ Core
#### new Core([parent])
| Param | Type |
| --- | --- |
| [parent] | Core \| StepChild \| any |
**Example**
```js
story (name, is usable for multiple stories to run)
step (name, type = checkboxes)
group
input (type = checkbox, input, confirm)
input
group
input
step (this is where it gets tricky eh)
group
input
step
group...
```
#### core.handleParent([parent])
binds parent methods to child for easy chaining back up
**Kind**: instance method of [Core](#Core.module_js..Core)
**Access**: protected
| Param | Type |
| --- | --- |
| [parent] | any |
#### core.decorateCurrent() ⇒ Core
decorates the latest step for easy chaining
**Kind**: instance method of [Core](#Core.module_js..Core)
**Returns**: Core - @chainable
**Access**: protected
#### core.program(...args) ⇒ Program
**Kind**: instance method of [Core](#Core.module_js..Core)
| Param | Type | Description |
| --- | --- | --- |
| ...args | VorpalArgs | args to pass to Vorpal |
#### core.onAnswers([cb]) ⇒ Core
function to call each time a user inputs an answer
**Kind**: instance method of [Core](#Core.module_js..Core)
**Returns**: Core - @chainable
| Param | Type | Default |
| --- | --- | --- |
| [cb] | function | Function.prototype |
#### core.then(cb) ⇒ Core
after all answers are done,
since we chain the promises
it is a delayed promise resolve
**Kind**: instance method of [Core](#Core.module_js..Core)
**Returns**: Core - @chainable
| Param | Type |
| --- | --- |
| cb | function |
#### core.run() ⇒ Promise
calls toConfig,
passes in .then to stepper when there is one,
starts the stepper
**Kind**: instance method of [Core](#Core.module_js..Core)
#### core.child(name, type, [msg]) ⇒ StepChild
similar to stepChild, but adds to THIS.steps, not PARENT.steps
**Kind**: instance method of [Core](#Core.module_js..Core)
**Returns**: StepChild - @chainable
**Todo:**: abstract this and stepChild
**Todo:**: pass in condition (when) here optionally
**See**: this.stepChild, StepChild
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | key for the step, ends up on answers |
| type | string | | any valid vorpal `type` |
| [msg] | string | null | defaults to `name`, text that is shown |
#### core.stepChild(name, [type], [msg]) ⇒ StepChild
add a child step that has an auto-setup .when condition to be used
**Kind**: instance method of [Core](#Core.module_js..Core)
**Returns**: StepChild - @chainable
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | key for the step, ends up on answers |
| [type] | string | "'list'" | any valid vorpal `type` |
| [msg] | string | null | defaults to `name`, text that is shown |
#### Core.program() ⇒ Core
**Kind**: static method of [Core](#Core.module_js..Core)
**See**: Core.program
#### Core.init([parent]) ⇒ Core
**Kind**: static method of [Core](#Core.module_js..Core)
| Param | Type |
| --- | --- |
| [parent] | Core \| StepChild \| any |
## Program.js
a wrapper for Vorpal
**Requires**: module:funwithflags, module:vorpal, module:inspector-gadget, module:flipchain/ChainedSet, module:flipchain/ChainedMap, module:./Script
* [Program.js](#Program.module_js)
* [~Program](#Program.module_js..Program) : ChainedMap
* [new Program(parent)](#new_Program.module_js..Program_new)
* [.program([version])](#Program.module_js..Program+program) ⇒ Vorpal
* [.use(middleware)](#Program.module_js..Program+use) ⇒ Program
* [.actionPrompt(name, [type], [msg], [cb])](#Program.module_js..Program+actionPrompt) ⇒ Vorpal
### Program.js~Program : ChainedMap
**Kind**: inner class of [Program.js](#Program.module_js)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| inspect | function | inspector-gadget .inspect helper |
| actions | ChainedSet | |
| middleware | Object | |
* [~Program](#Program.module_js..Program) : ChainedMap
* [new Program(parent)](#new_Program.module_js..Program_new)
* [.program([version])](#Program.module_js..Program+program) ⇒ Vorpal
* [.use(middleware)](#Program.module_js..Program+use) ⇒ Program
* [.actionPrompt(name, [type], [msg], [cb])](#Program.module_js..Program+actionPrompt) ⇒ Vorpal
#### new Program(parent)
wrapper around vorpal
| Param | Type |
| --- | --- |
| parent | Program \| any |
#### program.program([version]) ⇒ Vorpal
**Kind**: instance method of [Program](#Program.module_js..Program)
**Returns**: Vorpal - new
**Todo:**: get the pkg json version
| Param | Type | Default |
| --- | --- | --- |
| [version] | string | null |
#### program.use(middleware) ⇒ Program
use a middleware
**Kind**: instance method of [Program](#Program.module_js..Program)
**Returns**: Program - @chainable
| Param | Type |
| --- | --- |
| middleware | Object |
#### program.actionPrompt(name, [type], [msg], [cb]) ⇒ Vorpal
**Kind**: instance method of [Program](#Program.module_js..Program)
| Param | Type | Default |
| --- | --- | --- |
| name | string | |
| [type] | string | "'checkbox'" |
| [msg] | string | null |
| [cb] | function | module:flipchain, module:fliplog, module:./Choice
* [Question.js](#Question.module_js)
* [~Question](#Question.module_js..Question) : ChainedMap
* [new Question(parent)](#new_Question.module_js..Question_new)
* [.checkbox(name, [checked], [msg])](#Question.module_js..Question+checkbox) ⇒ Question
* [.confirm(name, [msg])](#Question.module_js..Question+confirm) ⇒ Question
* [.input(name, [msg])](#Question.module_js..Question+input) ⇒ Question
* [.list(name, [msg])](#Question.module_js..Question+list) ⇒ Question
* [.choice(name, [msg])](#Question.module_js..Question+choice) ⇒ Question
* [.separator([msg])](#Question.module_js..Question+separator) ⇒ Question
* [.shorthand(list, arg, fn)](#Question.module_js..Question+shorthand) ⇒ Question
* [.shorthandFactory(methods)](#Question.module_js..Question+shorthandFactory) ⇒ Question
* [.toConfig()](#Question.module_js..Question+toConfig) ⇒ Object
* [.when(fn)](#Question.module_js..Question+when) ⇒ Question
* [.whenIncl(props, [needles])](#Question.module_js..Question+whenIncl) ⇒ Question
### Question.js~Question : ChainedMap
**Kind**: inner class of [Question.js](#Question.module_js)
**Properties**
| Name | Type |
| --- | --- |
| _choices | ChainedSet |
| current | Choice |
* [~Question](#Question.module_js..Question) : ChainedMap
* [new Question(parent)](#new_Question.module_js..Question_new)
* [.checkbox(name, [checked], [msg])](#Question.module_js..Question+checkbox) ⇒ Question
* [.confirm(name, [msg])](#Question.module_js..Question+confirm) ⇒ Question
* [.input(name, [msg])](#Question.module_js..Question+input) ⇒ Question
* [.list(name, [msg])](#Question.module_js..Question+list) ⇒ Question
* [.choice(name, [msg])](#Question.module_js..Question+choice) ⇒ Question
* [.separator([msg])](#Question.module_js..Question+separator) ⇒ Question
* [.shorthand(list, arg, fn)](#Question.module_js..Question+shorthand) ⇒ Question
* [.shorthandFactory(methods)](#Question.module_js..Question+shorthandFactory) ⇒ Question
* [.toConfig()](#Question.module_js..Question+toConfig) ⇒ Object
* [.when(fn)](#Question.module_js..Question+when) ⇒ Question
* [.whenIncl(props, [needles])](#Question.module_js..Question+whenIncl) ⇒ Question
#### new Question(parent)
| Param | Type |
| --- | --- |
| parent | ChainedMap \| any |
#### question.checkbox(name, [checked], [msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**See**: Question.factory
**Since**: 0.0.6
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | |
| [checked] | boolean | false | |
| [msg] | string | | defaults to name |
#### question.confirm(name, [msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**See**: Question.factory
**Since**: 0.0.6
| Param | Type | Description |
| --- | --- | --- |
| name | string | |
| [msg] | string | defaults to name |
#### question.input(name, [msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**See**: Question.factory
**Since**: 0.0.6
| Param | Type | Description |
| --- | --- | --- |
| name | string | |
| [msg] | string | defaults to name |
#### question.list(name, [msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**See**: Question.factory
**Since**: 0.0.6
| Param | Type | Description |
| --- | --- | --- |
| name | string | |
| [msg] | string | defaults to name |
#### question.choice(name, [msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**See**: Question.factory
**Since**: 0.0.6
| Param | Type | Description |
| --- | --- | --- |
| name | string | |
| [msg] | string | defaults to name |
#### question.separator([msg]) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**Since**: 0.0.8
| Param | Type | Default |
| --- | --- | --- |
| [msg] | string | "'==='" |
#### question.shorthand(list, arg, fn) ⇒ Question
adds shorthand methods using the factory
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**Access**: protected
**See**: Question.constructor
| Param | Type |
| --- | --- |
| list | Array.<string> |
| arg | any |
| fn | function |
#### question.shorthandFactory(methods) ⇒ Question
take single methods, add as multi methods
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**Since**: 0.0.8
| Param | Type | Description |
| --- | --- | --- |
| methods | Array.<string> | methods to add `s` to and decorate Question |
**Example**
```js
separator -> separators
```
#### question.toConfig() ⇒ Object
**Kind**: instance method of [Question](#Question.module_js..Question)
**See**: Question._choices
**Since**: 0.0.8
#### question.when(fn) ⇒ Question
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**Todo:**: chainedSet instead
**Since**: 0.0.8
| Param | Type |
| --- | --- |
| fn | function |
#### question.whenIncl(props, [needles]) ⇒ Question
when using two args, checks first arg as prop(s), second as does-include
when using a single arg, it checks against last answer
**Kind**: instance method of [Question](#Question.module_js..Question)
**Returns**: Question - @chainable
**Since**: 0.0.9
| Param | Type | Default |
| --- | --- | --- |
| props | string \| Array.<string> | |
| [needles] | string \| Array.<string> | null |
## Stepper.js
a Stepper chain
**Requires**: module:inquirer, module:fliplog, module:./StepperPersistance
* [Stepper.js](#Stepper.module_js)
* [~Stepper](#Stepper.module_js..Stepper) : ChainedMap
* [new Stepper(parent)](#new_Stepper.module_js..Stepper_new)
* [.start(steps)](#Stepper.module_js..Stepper+start) ⇒ Promise
* [._start()](#Stepper.module_js..Stepper+_start) ⇒ Stepper
* [.setupStdIn()](#Stepper.module_js..Stepper+setupStdIn) ⇒ Stepper
* [.thenner()](#Stepper.module_js..Stepper+thenner) ⇒ Promise \| null
### Stepper.js~Stepper : ChainedMap
**Kind**: inner class of [Stepper.js](#Stepper.module_js)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| parent | \* | |
| data | Object | answers from prompting |
| answerCallbacks | \* \| function | |
| goingBack | boolean | for stepping back in interactive |
| indx | number | current step index |
| prompter | Object | inquirer instance |
| ui | Object | inquirer.ui |
| steps | Array.<Step> | in Stepper.start |
| resolve | function | in Stepper.start, for using .then |
| stdin | Object | for subscribing to stdin events (for going back) |
| persistance | StepperPersistance | persisting & hydrating |
* [~Stepper](#Stepper.module_js..Stepper) : ChainedMap
* [new Stepper(parent)](#new_Stepper.module_js..Stepper_new)
* [.start(steps)](#Stepper.module_js..Stepper+start) ⇒ Promise
* [._start()](#Stepper.module_js..Stepper+_start) ⇒ Stepper
* [.setupStdIn()](#Stepper.module_js..Stepper+setupStdIn) ⇒ Stepper
* [.thenner()](#Stepper.module_js..Stepper+thenner) ⇒ Promise \| null
#### new Stepper(parent)
| Param | Type |
| --- | --- |
| parent | Chainable \| any |
#### stepper.start(steps) ⇒ Promise
sets this.resolve in a returned promise
which can be used by Stepper.then
when iterating through steps in Stepper.thenner
**Kind**: instance method of [Stepper](#Stepper.module_js..Stepper)
**Since**: 0.0.8
| Param | Type |
| --- | --- |
| steps | Array.<Step> |
#### stepper._start() ⇒ Stepper
does actual setup
**Kind**: instance method of [Stepper](#Stepper.module_js..Stepper)
**Returns**: Stepper - @chainable
**Access**: protected
**See**: this.start, persistance.hydrate
**Since**: 0.0.11
#### stepper.setupStdIn() ⇒ Stepper
sets up process.stdin observer that will step back if needed
**Kind**: instance method of [Stepper](#Stepper.module_js..Stepper)
**Returns**: Stepper - @chainable
**See**: Stepper.index, Stepper.thenner, Stepper.start
**Since**: 0.0.9
**Todo**
- [ ] going back 2 doubles things, need to clear and fix?
#### stepper.thenner() ⇒ Promise \| null
**Kind**: instance method of [Stepper](#Stepper.module_js..Stepper)
**See**: Stepper.steps
**Since**: 0.0.6
## StepperPersistance.js
a Stepper persisting chain
**Requires**: module:configstore, module:fliplog, module:inquirer, module:prettydate, module:flipchain/ChainedMap
* [StepperPersistance.js](#StepperPersistance.module_js)
* [~StepperPersistance](#StepperPersistance.module_js..StepperPersistance) : ChainedMap
* [new StepperPersistance()](#new_StepperPersistance.module_js..StepperPersistance_new)
* [.reset([steps])](#StepperPersistance.module_js..StepperPersistance+reset) ⇒ StepperPersistance
* [.isHydratable(steps)](#StepperPersistance.module_js..StepperPersistance+isHydratable) ⇒ boolean
* [.persist()](#StepperPersistance.module_js..StepperPersistance+persist) ⇒ StepperPersistance
* [.removeStdIn()](#StepperPersistance.module_js..StepperPersistance+removeStdIn) ⇒ StepperPersistance
* [.onStdIn(buffer)](#StepperPersistance.module_js..StepperPersistance+onStdIn) ⇒ Buffer
* [.echoCurrent()](#StepperPersistance.module_js..StepperPersistance+echoCurrent) ⇒ StepperPersistance
* [.getData()](#StepperPersistance.module_js..StepperPersistance+getData) ⇒ Object
* [.handleDelete()](#StepperPersistance.module_js..StepperPersistance+handleDelete) ⇒ StepperPersistance
* [.handleCancelDelete()](#StepperPersistance.module_js..StepperPersistance+handleCancelDelete) ⇒ StepperPersistance
* [.promptDelete()](#StepperPersistance.module_js..StepperPersistance+promptDelete) ⇒ StepperPersistance
* [.rehydrate(indx, data)](#StepperPersistance.module_js..StepperPersistance+rehydrate) ⇒ StepperPersistance
* [.thenner()](#StepperPersistance.module_js..StepperPersistance+thenner) ⇒ Class
### StepperPersistance.js~StepperPersistance : ChainedMap
**Kind**: inner class of [StepperPersistance.js](#StepperPersistance.module_js)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| showing | boolean | showing the list |
| deleting | boolean | prompting deleting of an item |
| hydrated | boolean | already rehydrated, when prompting to rehydrate |
| confirming | boolean | asking to resume, don't listen to keypresses |
| indx | number | current _session_ index, varies from Stepper.indx |
| hash | string | key to match sessions that are able to be used for a hash |
| stdin | Object | for subscribing to stdin events (for going back) |
| onStdIn | function | subscriber for stdin |
| sessions | Object | configstore sessions... |
| store | ConfigStore | configstore for persisting |
| prompter | Object | inquirer instance |
| ui | Object | inquirer.ui |
* [~StepperPersistance](#StepperPersistance.module_js..StepperPersistance) : ChainedMap
* [new StepperPersistance()](#new_StepperPersistance.module_js..StepperPersistance_new)
* [.reset([steps])](#StepperPersistance.module_js..StepperPersistance+reset) ⇒ StepperPersistance
* [.isHydratable(steps)](#StepperPersistance.module_js..StepperPersistance+isHydratable) ⇒ boolean
* [.persist()](#StepperPersistance.module_js..StepperPersistance+persist) ⇒ StepperPersistance
* [.removeStdIn()](#StepperPersistance.module_js..StepperPersistance+removeStdIn) ⇒ StepperPersistance
* [.onStdIn(buffer)](#StepperPersistance.module_js..StepperPersistance+onStdIn) ⇒ Buffer
* [.echoCurrent()](#StepperPersistance.module_js..StepperPersistance+echoCurrent) ⇒ StepperPersistance
* [.getData()](#StepperPersistance.module_js..StepperPersistance+getData) ⇒ Object
* [.handleDelete()](#StepperPersistance.module_js..StepperPersistance+handleDelete) ⇒ StepperPersistance
* [.handleCancelDelete()](#StepperPersistance.module_js..StepperPersistance+handleCancelDelete) ⇒ StepperPersistance
* [.promptDelete()](#StepperPersistance.module_js..StepperPersistance+promptDelete) ⇒ StepperPersistance
* [.rehydrate(indx, data)](#StepperPersistance.module_js..StepperPersistance+rehydrate) ⇒ StepperPersistance
* [.thenner()](#StepperPersistance.module_js..StepperPersistance+thenner) ⇒ Class
#### new StepperPersistance()
check if there are any saved states
prompt with a list of saved states
allow deleting of those saved states
#### stepperPersistance.reset([steps]) ⇒ StepperPersistance
setup and reset
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Since**: 0.0.11
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [steps] | Array.<Step> | boolean
checks if there are existing stored sessions
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: boolean - hydratable or not
**See**: configstore, Stepper, StepperPersistance.reset
**Since**: 0.0.11
| Param | Type | Description |
| --- | --- | --- |
| steps | Object | stringified steps to serve as a hash |
#### stepperPersistance.persist() ⇒ StepperPersistance
save the current index and state
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**See**: configstore
**Since**: 0.0.11
#### stepperPersistance.removeStdIn() ⇒ StepperPersistance
unsubscribes
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Access**: protected
**Since**: 0.0.11
#### stepperPersistance.onStdIn(buffer) ⇒ Buffer
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: Buffer - stdin buffer
| Param | Type | Description |
| --- | --- | --- |
| buffer | Buffer | stdin buffer |
#### stepperPersistance.echoCurrent() ⇒ StepperPersistance
echos current session when using [->] or deleting
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Access**: protected
**See**: this.promptDelete
**Since**: 0.0.11
#### stepperPersistance.getData() ⇒ Object
transforms data with prettydate,
colors a message,
maps sessions to prompts
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: Object - latest session, message
**Since**: 0.0.11
#### stepperPersistance.handleDelete() ⇒ StepperPersistance
deletes current index, updates configstore
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Access**: protected
**See**: this.promptDelete, this.handleCancelDelete
**Since**: 0.0.11
#### stepperPersistance.handleCancelDelete() ⇒ StepperPersistance
removes listener / resets, starts again
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**See**: this.rehydrate
**Since**: 0.0.11
#### stepperPersistance.promptDelete() ⇒ StepperPersistance
closes ui, prompts to delete
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Todo:**: use Core here
**See**: this.echoCurrent, this.handleDelete, this.handleCancelDelete
**Since**: 0.0.11
#### stepperPersistance.rehydrate(indx, data) ⇒ StepperPersistance
rehydrate from a saved state
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: StepperPersistance - @chainable
**Access**: protected
**See**: this.thenner, Stepper._start
**Since**: 0.0.11
**Todo**
- [ ] use a .toConfig of steps
| Param | Type |
| --- | --- |
| indx | number |
| data | Array.<\*> |
#### stepperPersistance.thenner() ⇒ Class
prompts to rehydrate
**Kind**: instance method of [StepperPersistance](#StepperPersistance.module_js..StepperPersistance)
**Returns**: Class - @chainable
**See**: this.getData
**Since**: 0.0.11
## Steps.js
a Step chain
**Requires**: module:flipchain/ChainedSet, module:flipchain/ChainedMap
### Steps.js~Steps : ChainedSet
**Kind**: inner class of [Steps.js](#Steps.module_js)
**Todo:**: instead of an array needs to return obj?
**Properties**
| Name | Type |
| --- | --- |
| data | ChainedSet |
## cli-chain
entry point
**Requires**: module:likeaboss, module:vorpal, module:lodash.sortBy, module:inspector-gadget, module:to-arr, module:inquirer, module:./Core
## Presets : ChainedMap
**Kind**: global class
**Todo:**: - [ ] should be configurable
if they want presets to be saved to pkgjson
or to a file that is not gitignored
add
makes a config file for presets
load
loads an existing presets from the config file
executes it in a subprocess
it should (be able to) reset argv, then re-run program
**Note**: WIP
* [Presets](#Presets) : ChainedMap
* [.getKeyFlag(val, prop)](#Presets+getKeyFlag) ⇒ Object
* [.add(preset, [order])](#Presets+add)
### presets.getKeyFlag(val, prop) ⇒ Object
**Kind**: instance method of [Presets](#Presets)
| Param | Type |
| --- | --- |
| val | string \| Array.<string> |
| prop | string |
### presets.add(preset, [order])
**Kind**: instance method of [Presets](#Presets)
**Todo:**: - [ ] need to add some decorator/transformer that changes it when saving...
| Param | Type | Default |
| --- | --- | --- |
| preset | Object | |
| [order] | Array.<string> | [] |
## choice(name, [type], [msg]) ⇒ StepChild
add a step, which is a new Question
**Kind**: global function
**Returns**: StepChild - @chainable
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | | key for the step, ends up on answers |
| [type] | string | "'checkbox'" | |
| [msg] | string | null | defaults to `name`, text that is shown |
## init() ⇒ StepsFrom
**Kind**: global function
**Returns**: StepsFrom - @chainable