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');
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'});
API
Create a new question with the given name
, message
and options
.
Params
name
{String|Object}: Question name or options.message
{String|Object}: Question message or options.options
{String|Object}: Question options.
Example
var question = new Question('first', 'What is your first name?');
console.log(question);
Clone the question instance.
returns
{Object}: Returns the cloned question
Example
var clonedQuestion = question.clone();
Add formatted choice objects to the question.choices
array. See prompt-choices for more details.
Params
choices
{String|Array}: One or more choices to add.returns
{Object}: Returns the question instance for chaining
Example
question.addChoices(['foo', 'bar', 'baz']);
Add a choice to question.choices
array. See prompt-choices for more details.
Params
choice
{String|Object}returns
{Object}: Returns the question instance for chaining
Example
question.addChoice('foo');
Returns the given val
or question.default
if val
is undefined or null.
Params
Example
var question = new Question({
name: 'first',
message: 'First name'?,
default: 'Bob'
});
console.log(question.getAnswer());
console.log(question.getAnswer('Joe'));
console.log(question.getAnswer(false));
console.log(question.getAnswer(0));
Get the given choice from questions.choices
.
Params
Example
var Question = require('prompt-question');
var question = new Question('color', 'What is your favorite color?', {
choices: ['red', 'blue', 'yellow']
});
console.log(question.getChoice('red'));
Create a separator using choices-separator.
Getter that returns true if a default
value has been defined.
returns
{Boolean}: True if a default value is defined.
Getter/setter for the checkbox symbols to use.
returns
{Object}: Checkbox object with .on
, .off
and .disabled
properties.
Example
var question = new Question({
name: 'foo',
checkbox: {off: '[ ]', on: '[x]', disabled: 'X'}
});
question.checkbox = {off: '[ ]', on: '[x]', disabled: 'X'};
Getter/setter for getting and setting choices (if applicable).
Example
var question = new Question();
question.choices = ['a', 'b', 'c'];
Static method that returns true if question
is a valid question object.
Params
question
{Object}returns
{Boolean}
Example
console.log(Question.isQuestion('foo'));
console.log(Question.isQuestion(new Question('What is your name?')));
Static method for creating a new Choices
object. See prompt-choices for more details.
Params
choices
{Array}: Array of choicesreturns
{Object}: Returns an intance of Choices.
Example
var choices = new Question.Choices(['foo', 'bar', 'baz']);
Static method for creating a new Separator
object. See choices-separator for more details.
Params
separator
{String}: Optionally pass a string to use as the separator.returns
{Object}: Returns a separator object.
Example
new Question.Separator();
Release history
v5.0.0
- Support
.choices
as a function
v4.0.0
v3.0.0
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
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
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
License
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 08, 2017.