Skip to content

pionl/listr-inquirer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npm

Input module for Listr and Inquirer

Install

$ npm install --save listr-inquirer

Usage

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 by Sam Verschueren