![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'}]);
Render the current choices.
Params
position
{Number}: Cursor positionoptions
{Object}returns
{String}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']);
Add a normalized choice
object to the choices
array.
Params
choice
{string|Object}: One or more choices to add.Example
choices.addChoice(['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();
Returns true if a choice exists.
Params
val
{Number}: The index or key of the choice to check for.returns
{Boolean}Example
choices.hasChoice(1);
choices.hasChoice('foo');
Get the choice or separator object at the specified index.
Params
key
{Number|String}: The name or index of the object to getreturns
{Object}: Returns the specified choiceExample
var choice = choices.get(1);
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);
choices.getChoice('foo');
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
var choices = new Choices(['foo', 'bar', 'baz']);
console.log(choices.getIndex('foo')); //=> 0
console.log(choices.getIndex('baz')); //=> 2
console.log(choices.getIndex('bar')); //=> 1
console.log(choices.getIndex('qux')); //=> -1
Call the given method
on choices.actions
Params
method
{String}pos
{Number}Example
choices.action('up', 1);
Check the choice at the given idx
.
Params
val
{Number|Array}: The key(s) or index(s) of the choice(s) to check.Example
choices.check(1);
Disable the choice at the given idx
.
Params
idx
{Number}: The index of the choice to enable.Example
choices.uncheck(1);
Toggle the choice at the given idx
.
Params
idx
{Number}: The index of the choice to toggle.Example
choices.toggle(1);
// radio mode
choices.toggle(1, true);
Return choice values for choices that return truthy based
on the given val
.
Params
val
{Object|Function|String|RegExp}returns
{Array}: Matching choices or empty arrayReturns true if the given index
is a valid choice index.
Params
key
{String}: Property name to use for plucking objects.returns
{Array}: Plucked objectsReturn the .key
property from the choice at the given index.
Params
key
{String}: Property name to use for plucking objects.returns
{Array}: Plucked objectsPluck 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 checked choices from the collection.
Getter for getting the length of the collection.
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();
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
var Choices = require('prompt-choices');
var choices = new Choices(['foo']);
console.log(Choices.isChoices(choices)); //=> true
console.log(Choices.isChoices({})); //=> false
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
var Choices = require('prompt-choices');
var choices = new Choices(['foo']);
var foo = choices.getChoice('foo');
console.log(Choices.isChoice(foo)); //=> true
console.log(Choices.isChoice({})); //=> false
Changed
Move
class to Actions
choices.move
property to choices.actions
Removed
.enable
and .disable
prototype methods from both Choice
and Choices
. These methods were ambiguous as they blurred the distinction between "enabling" a choice (meaning that it's "checked") versus enabling a property on a choice. If this is confusing, that's why they were removed.Added
Actions
class (previously named Move
) for managing actions on choices.addChoice
prototype method, for adding a single choice after instantiation.action
prototype method to Choices
, which calls a method on the Actions
class.check
and .uncheck
prototype methods (previously ambiguously named .enable
and .disable
)Some of the code in this library was initially based on the Choices
class in Inquirer.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(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 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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 10, 2017.
FAQs
Create an array of multiple choice objects for use in prompts.
The npm package prompt-choices receives a total of 35,913 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.