add docs
This commit is contained in:
parent
efada244c2
commit
9420815809
53
README.md
53
README.md
@ -1,15 +1,16 @@
|
||||
# smartinteract
|
||||
interact with terminal users
|
||||
smart cli interaction
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/smartinteract)
|
||||
[](https://gitlab.com/pushrocks/smartinteract)
|
||||
[](https://github.com/pushrocks/smartinteract)
|
||||
[](https://pushrocks.gitlab.io/smartinteract/)
|
||||
[](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://GitLab.com/pushrocks/smartinteract/commits/master)
|
||||
[](https://GitLab.com/pushrocks/smartinteract/commits/master)
|
||||
[](https://www.npmjs.com/package/smartinteract)
|
||||
[](https://david-dm.org/pushrocks/smartinteract)
|
||||
[](https://www.bithound.io/github/pushrocks/smartinteract/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/smartinteract)
|
||||
@ -18,39 +19,11 @@ interact with terminal users
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Usage
|
||||
We recommend the use of TypeScript for best in class intellesense
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
```javascript
|
||||
import { SmartInteract } from 'smartinteract'
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
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
|
||||
})
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
// 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)
|
||||
[](https://push.rocks)
|
||||
|
||||
60
docs/index.md
Normal file
60
docs/index.md
Normal file
@ -0,0 +1,60 @@
|
||||
# smartinteract
|
||||
smart cli interaction
|
||||
|
||||
## 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://www.npmjs.com/package/smartinteract)
|
||||
[](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
|
||||
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.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[](https://push.rocks)
|
||||
Loading…
Reference in New Issue
Block a user