JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 79153
  • Score
    100M100P100Q157560F
  • License MIT

Question object, used by Enquirer and prompt plugins.

Package Exports

  • prompt-question

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (prompt-question) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

prompt-question NPM version NPM downloads Build Status

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'});

About

  • 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 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

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.1.31, on September 21, 2016.