to-choices

to-choices

Generate an inquirer choices question from an array.

Install

Install with npm

$ npm i to-choices --save

Usage

var toChoices = require('to-choices');

var question = toChoices('foo', ['a', 'b', 'c']);
console.log(question);

Results in:

{ type: 'checkbox',
  name: 'foo',
  message: 'foo',
  choices:
   [ { name: 'all', value: ['a', 'b', 'c'] },
     { type: 'separator', line: '\u001b[90m————\u001b[39m' },
     { name: 'a' },
     { name: 'b' },
     { name: 'c' } ] }

See the inquirer documentation for more details about question objects and supported properties.

API

toChoices

Create a question object with the given name and array of choices.

Params

• name {String|Object}: Name of the question or object with a name property.
• options {Object|Array}: Question options or array of choices. If an array of choices is specified, the name will be used as the message.
• returns {Object}

Example

toChoices(name[, options]);

Related projects

• answer-store: Store answers to user prompts, based on locale and/or current working directory. | homepage
• question-store: Ask questions, persist the answers. Basic support for i18n and storing answers based on current… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on November 29, 2015.