prompt-confirm     

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

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

!prompt-confirm example

Install

Install with npm:

``sh
$ npm install --save prompt-confirm
`

Usage

Question

Pass a string or question object to the constructor:

`js
const Confirm = require('prompt-confirm');
const prompt = new Confirm('Do you like chocolate?');

// or
const prompt = new Confirm({
name: 'chocolate',
message: 'Do you like chocolate?'
});
`

Run the prompt

You can use one of the following two methods for running the prompt:

`js
// async
prompt.ask(function(answer) {
console.log(answer);
});

// or promise
prompt.run()
.then(function(answer) {
console.log(answer);
});
`

Examples

`js
const confirm = new Confirm('Like chocolate?')
.ask(function(answer) {
console.log(answer);
});

const confirm = new Confirm('Like chocolate?')
.run()
.then(function(answer) {
console.log(answer);
});
`

Usage with enquirer

`js
const Enquirer = require('enquirer');
const enquirer = new Enquirer();

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

$3

Enquirer supports either the declarative object-oriented (inquirer-style) question format or a more expressive format using the .question method.

Declarative

Inquirer-style declarative format (takes an array or object):

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

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

Expressive

Pre-define questions and easily compose prompts by passing the name(s) of the prompts to run:

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

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

About

$3

You might also be interested in these projects:

* enquirer-prompt: Base prompt module used for creating custom prompt types for Enquirer. | homepage
* enquirer: Intuitive, plugin-based prompt system for node.js. | homepage
* prompt-checkbox: Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like Enquirer. | homepage
* prompt-radio: Radio prompt. Can be used as a standalone prompt, or as a plugin for Enquirer. | homepage

$3

| Commits | Contributor |
| --- | --- |
| 39 | jonschlinkert |
| 9 | doowb |

$3

Jon Schlinkert

* LinkedIn Profile
* GitHub Profile
* Twitter Profile

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on May 28, 2018._