enquirer-prompt-input

enquirer-prompt-input

Input prompt plugin for Enquirer. This is the only prompt type included in Enquirer by default and does not need to be registered separately.

Install

Install with npm:

$ npm install --save enquirer-prompt-input

Usage

var Input = require('enquirer-prompt-input');
var input = new Input({
  name: 'first',
  message: 'What is your name?'
});

input.ask(function(answers) {
  console.log(answers);
});

Enquirer usage

This is the only prompt type included in enquirer by default, so you don't need to register this with enquirer. The following is only an example of how custom prompts are registered.

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

// register the prompt type with enquirer
enquirer.register('input', require('enquirer-prompt-input'));

var Enquirer = require('enquirer');
var enquirer = new Enquirer();
enquirer.register('input', require('enquirer-prompt-input'));

var questions = [
  {
    type: 'input',
    name: 'first',
    message: 'First name?',
    default: 'Brian'
  },
  {
    type: 'input',
    name: 'last',
    message: 'Last name?',
    default: 'Woodward'
  }
];

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

Attribution

Based on the input prompt in inquirer.

About

Related projects

• enquirer-prompt: Base prompt module used for creating custom prompt types for Enquirer. | homepage
• enquirer-question: Question object, used by Enquirer and prompt plugins. | homepage
• enquirer: Plugin-based prompt system for node.js | 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.1.30, on August 30, 2016.