prompt-confirm

prompt-confirm

Confirm (yes/no) prompt. Can be used standalone or with a prompt system like Enquirer.

Install

Install with npm:

$ npm install --save prompt-confirm

Usage

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('confirm', require('prompt-confirm'));

Example

Enquirer supports both the declarative inquirer-style question format and a functional format using the .question method:

Single question

Ask one question using the .prompt method:

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('prompt-confirm'));

enquirer.question('chocolate', 'Like chocolate?', {type: 'confirm'});
enquirer.question('vanilla', 'Like vanilla?', {type: 'confirm'});

enquirer.prompt('vanilla')
  .then(function(answers) {
    console.log(answers)
  });

Functional

Functional style questions.

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('prompt-confirm'));

enquirer.question('chocolate', 'Like chocolate?', {type: 'confirm'});
enquirer.question('vanilla', 'Like vanilla?', {type: 'confirm'});

enquirer.ask(['chocolate', 'vanilla'])
  .then(function(answers) {
    console.log(answers)
  });

Declarative

Inquirer-style questions format.

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('prompt-confirm'));

var questions = [
  {type: 'confirm', name: 'chocolate', message: 'Like chocolate?'},
  {type: 'confirm', name: 'vanilla', message: 'Like vanilla?'}
];

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers)
  });

Attribution

Based on the confirm prompt in inquirer.

About

Related projects

• enquirer-prompt: Base prompt module used for creating custom prompt types for Enquirer. | homepage
• enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | homepage
• prompt-checkbox: Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like Enquirer. | homepage
• prompt-radio: Radio prompt. This prompt behaves like other radio-button interfaces, where only one choice is enabled… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.0, on October 20, 2016.