58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
# @[object Object]/[object Object]
|
|
[object Object]
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/[object Object])
|
|
* [gitlab.com (source)](https://[object Object]/[object Object]/[object Object])
|
|
* [github.com (source mirror)](https://github.com/[object Object]/[object Object])
|
|
* [docs (typedoc)](https://[object Object].gitlab.io/[object Object]/)
|
|
|
|
## Status for master
|
|
[](https://[object Object]/[object Object]/[object Object]/commits/master)
|
|
[](https://[object Object]/[object Object]/[object Object]/commits/master)
|
|
[](https://www.npmjs.com/package/[object Object])
|
|
[](https://snyk.io/test/npm/[object Object])
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```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 }
|
|
})
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> [object Object] licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|