https://github.com/pionl/listr-inquirer
Inquirer module for Listr
https://github.com/pionl/listr-inquirer
command-line inquirer listr nodejs prompt task-list
Last synced: 4 months ago
JSON representation
Inquirer module for Listr
- Host: GitHub
- URL: https://github.com/pionl/listr-inquirer
- Owner: pionl
- License: mit
- Created: 2018-09-20T18:29:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-20T18:35:44.000Z (over 6 years ago)
- Last Synced: 2025-02-01T04:31:49.076Z (5 months ago)
- Topics: command-line, inquirer, listr, nodejs, prompt, task-list
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
[](http://badge.fury.io/js/listr-inquirer)
> Input module for [Listr](https://github.com/SamVerschueren/listr) and [Inquirer](https://github.com/SBoudrias/Inquirer.js)
## Install
```
$ npm install --save listr-inquirer
```
## Usage
```js
const Listr = require('listr');
const inquirer = require('listr-inquirer');
const list = new Listr([
{
title: 'Retrieving data',
task: (ctx, task) => inquirer([
{
type: 'confirm',
name: 'continue',
message: 'Do you want to continue?'
}
], function (answers) {
if (false === answers.continue) {
task.skip('Skipped')
}
})
}
]);
list.run();
```
## API
### input(questions, done)
Returns an Observable which asks given set of questions.
#### questions
Type: `array`
https://github.com/SBoudrias/Inquirer.js/#question
### done
Type: `function`
Function that will be invoked when the user has answered the questions
## License
MIT © Original code from [listr-input](https://github.com/SamVerschueren/listr-input) by [Sam Verschueren](https://github.com/SamVerschueren)