57 lines
2.9 KiB
Markdown
57 lines
2.9 KiB
Markdown
# smartinteract
|
|
interact with terminal users
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/smartinteract)
|
|
[](https://gitlab.com/pushrocks/smartinteract)
|
|
[](https://github.com/pushrocks/smartinteract)
|
|
[](https://pushrocks.gitlab.io/smartinteract/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartinteract/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartinteract/commits/master)
|
|
[](https://david-dm.org/pushrocks/smartinteract)
|
|
[](https://www.bithound.io/github/pushrocks/smartinteract/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/smartinteract)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](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
|
|
name: 'question1',
|
|
type: 'input',
|
|
message: 'Who are you?',
|
|
default: 'Somebody',
|
|
validate: (inputString) => { return true } // implement your own validation
|
|
}])
|
|
myInteract.addQuestions([ ... ]) // add more questions
|
|
myInteract.runQueue()
|
|
.then(answerBucket => { // the bucket has all the answers of the completed queue
|
|
let answerQuestion1 = answerBucket.getAnswerFor('question1')
|
|
// do something with the answers
|
|
})
|
|
|
|
// alternatively use .askQuestion() for more direct control
|
|
myInteract.askQuestion{ // note: its an array. You can specify multiple questions
|
|
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 }
|
|
})
|
|
```
|
|
|
|
### 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
|
|
|
|
[](https://push.rocks)
|