![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
prompt-choices
Advanced tools
Readme
Create an array of multiple choice objects for use in prompts.
Install with npm:
$ npm install --save prompt-choices
var Choices = require('prompt-choices');
var choices = new Choices(['foo', 'bar', 'baz']);
Create a new Choices
collection.
Params
choices
{Array}: One or more choice
strings or objects.Example
var choices = new Choices(['foo', 'bar', 'baz']);
var choices = new Choices([{name: 'foo'}, {name: 'bar'}, {name: 'baz'}]);
Add an array of normalized choice
objects to the choices
array. This method is called in the constructor, but it can also be used to add choices after instantiation.
Params
choices
{Array|Object}: One or more choices to add.Example
choices.addChoices(['a', 'b', 'c']);
Create a new Choice
object.
Params
choice
{String|Object}returns
{Object}: Returns a choice object.Example
choices.choice('blue');
Create 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
choices.separator();
Get a non-separator choice from the collection.
Params
idx
{Number}: The selected choice indexreturns
{Object|undefined}: Return the matched choice object or undefinedExample
choices.getChoice(1);
Get the index of a non-separator choice from the collection.
Params
key
{String}: The key of the choice to getreturns
{Number}: Index of the choice or -1
;Example
choices.getChoice('foo');
Get the choice or separator object at the specified index.
Params
idx
{Number}: The index of the object to getreturns
{Object}: Returns the specified choiceExample
choices.getChoice(1);
Enable the choice at the given idx
.
Params
idx
{Number}: The index of the choice to enable.Example
choices.enable(1);
Disable the choice at the given idx
.
Params
idx
{Number}: The index of the choice to enable.Example
choices.disable(1);
Enable the choice at the given index
, and disable all other choices.
Params
idx
{Number}: The index of the choice to toggle.Example
choices.toggleChoices(1);
Toggle the choice at the given idx
.
Params
idx
{Number}: The index of the choice to toggle.Example
choices.toggleChoice(1);
Return choices that return truthy based on the given val
.
Params
val
{Object|Function|String}returns
{Array}: Matching choices or empty arrayPluck an object with the specified key from the choices collection.
Params
key
{String}: Property name to use for plucking objects.returns
{Array}: Plucked objectsGetter for getting the length of the collection.
Getter for getting all non-separator choices from the collection.
Getter for getting the length of the collection excluding non-separator choices.
Create 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 Choices.Separator();
Code is partially based on the Choices
class in Inquirer.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(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
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.30, on August 30, 2016.
FAQs
Create an array of multiple choice objects for use in prompts.
The npm package prompt-choices receives a total of 33,770 weekly downloads. As such, prompt-choices popularity was classified as popular.
We found that prompt-choices demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.