.verb.md

Install

{%= include("install-npm", {save: true}) %}

Usage

var Radio = require('{%= name %}');
var prompt = new Radio({
  name: 'colors',
  message: 'Favorite flavor?',
  choices: [
    'chocolate',
    'strawberry',
    'vanilla'
  ]
});

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

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

Enquirer plugin

Register as a plugin with [enquirer][]:

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

enquirer.register('{%= alias %}', require('{%= name %}'));

Enquirer examples

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

Declarative format

Questions can be defined as an array of objects, or a single question object:

var questions = [
  {
    name: 'color',
    message: 'What is your favorite color?',
    type: '{%= alias %}',
    default: 'blue',
    choices: ['red', 'yellow', 'blue']
  }
];

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

Expressive format

Functional style questions.

enquirer.question('color', 'Favorite color?', {
  type: '{%= alias %}',
  choices: ['red', 'yellow', 'blue']
});

enquirer.question('flavor', 'Favorite flavor?', {
  type: '{%= alias %}',
  default: 'chocolate',
  choices: ['chocolate'] //<= no need for other choices ;)
});

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

Options

options.pointer

Customize the pointer to use.

TODO

options.checkbox

Type: Object

Default: (TODO)

Customize the checkbox symbols to use.