A package for creating smart CLI interactions with customizable questions and answers.
Go to file
2020-08-31 19:23:52 +00:00
.vscode fix(core): update 2020-08-31 19:23:51 +00:00
test fix(core): update 2020-08-31 19:23:51 +00:00
ts fix(core): update 2020-08-31 19:23:51 +00:00
.gitignore fix(core): update 2020-08-31 19:23:51 +00:00
.gitlab-ci.yml fix(core): update 2020-08-31 19:23:51 +00:00
npmextra.json fix(core): update 2020-02-07 16:36:35 +00:00
package-lock.json 2.0.10 2020-08-31 19:23:52 +00:00
package.json 2.0.10 2020-08-31 19:23:52 +00:00
readme.md fix(core): update 2020-08-31 19:23:51 +00:00
tslint.json fix(core): update 2020-02-07 16:36:35 +00:00

@[object Object]/[object Object]

[object Object]

  • [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

Status Category Status Badge
GitLab Pipelines ![pipeline status](https://[object Object]/[object Object]/[object Object]/badges/master/pipeline.svg)
GitLab Pipline Test Coverage ![coverage report](https://[object Object]/[object Object]/[object Object]/badges/master/coverage.svg)
npm ![npm downloads per month](https://badgen.net/npm/dy/[object Object])
Snyk ![Known Vulnerabilities](https://badgen.net/snyk/[object Object]/[object Object])
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) ![PackagePhobia](https://badgen.net/packagephobia/install/[object Object])
PackagePhobia (package size on registry) ![PackagePhobia](https://badgen.net/packagephobia/publish/[object Object])
BundlePhobia (total size when bundled) ![BundlePhobia](https://badgen.net/bundlephobia/minzip/[object Object])
Platform support Supports Windows 10 Supports Mac OS X

Usage

Use TypeScript for best in class instellisense.

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 | By using this npm module you agree to our privacy policy

repo-footer