smartinteract/README.md

57 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2016-11-20 00:11:22 +00:00
# smartinteract
interact with terminal users
## Availabililty
2016-11-20 00:13:33 +00:00
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartinteract)
[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartinteract)
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartinteract)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartinteract/)
2016-11-20 00:11:22 +00:00
## Status for master
2016-11-20 00:13:33 +00:00
[![build status](https://gitlab.com/pushrocks/smartinteract/badges/master/build.svg)](https://gitlab.com/pushrocks/smartinteract/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartinteract/commits/master)
[![Dependency Status](https://david-dm.org/pushrocks/smartinteract.svg)](https://david-dm.org/pushrocks/smartinteract)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartinteract/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartinteract/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartinteract/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartinteract)
2016-11-20 00:11:22 +00:00
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
We recommend the use of TypeScript for best in class intellesense
```javascript
import { SmartInteract } from 'smartinteract'
let myInteract = new SmartInteract([{ // note: its an array. You can specify multiple questions
2016-11-20 21:24:09 +00:00
name: 'question1',
2016-11-20 00:11:22 +00:00
type: 'input',
message: 'Who are you?',
default: 'Somebody',
validate: (inputString) => { return true } // implement your own validation
}])
2016-12-10 16:30:04 +00:00
myInteract.addQuestions([ ... ]) // add more questions
myInteract.runQueue()
2016-11-20 21:24:09 +00:00
.then(answerBucket => { // the bucket has all the answers of the completed queue
let answerQuestion1 = answerBucket.getAnswerFor('question1')
2016-11-20 00:11:22 +00:00
// do something with the answers
})
2016-11-20 21:24:09 +00:00
// alternatively use .askQuestion() for more direct control
2016-12-10 16:30:04 +00:00
myInteract.askQuestion{ // note: its an array. You can specify multiple questions
2016-11-20 21:24:09 +00:00
name: 'question2',
type: 'confirm',
message: 'Do you speak English?',
default: true,
validate: (inputString) => { return true } // implement your own validation
}().then(answerObject => {
// answerObject looks like { name: 'question2', value: true }
})
2016-11-20 00:14:46 +00:00
```
2016-11-20 21:24:09 +00:00
### Environment
In some environments like CI there is no user input to be expected.
smartinteract will always directyl create an answer from the default value
2016-11-20 00:14:46 +00:00
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)