enquirer-question v0.3.0

enquirer-question

Question object, used by Enquirer and prompt plugins.

Install

Install with npm:

$ npm install --save enquirer-question

Usage

The main export is a constructor function that is used to create new Question objects, which are used in prompts by enquirer.

var Question = require('enquirer-question');
var question = new Question('color', 'What is favorite color?');

Examples

Any of the following signatures may be used:

var question = new Question('color'); // sets message as the same value as `name`
var question = new Question('color', 'What is favorite color?');
var question = new Question('color', {message: 'What is favorite color?'});
var question = new Question({name: 'color', message: 'What is favorite color?'});
var question = new Question({name: 'color'});

About

Related projects

• choices-separator: Separator for choices arrays in prompts. Based on the Separator from inquirer. | homepage
• enquirer: Plugin-based prompt system for node.js | homepage
• prompt-choices: Create an array of multiple choice objects for use in prompts. | homepage
• readline-utils: Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more. | homepage

Contributing

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

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

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.