prompt-question

prompt-question

Question object, used by Enquirer and prompt plugins.

Install

Install with npm:

$ npm install --save prompt-question

Usage

The main export is a constructor function that is used to create new Question objects, which are used in prompts by [base-prompt][].

var Question = require('prompt-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'});

Release history

v2.0.0

• bumps prompt-choices. A major bump was warranted due to potentially breaking changes in prompt-choices. Please see that library for more details.

About

Related projects

• choices-separator: Separator for choices arrays in prompts. Based on the Separator from inquirer. | homepage
• enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | 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 advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

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

---

This file was generated by verb-generate-readme, v0.6.0, on May 12, 2017.