42 lines
2.2 KiB
Markdown
42 lines
2.2 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
|
|
type: 'input',
|
|
message: 'Who are you?',
|
|
default: 'Somebody',
|
|
choices: { ... }, // optional, only needed if type is 'choice'
|
|
validate: (inputString) => { return true } // implement your own validation
|
|
}])
|
|
SmartInteract.addQuestions([ ... ]) // add more questions
|
|
SmartInteract.runQueue()
|
|
.then(answersArray => {
|
|
// do something with the answers
|
|
})
|
|
|
|
```
|
|
|
|
[](https://push.rocks)
|