tjbenton / inquirer-autocomplete-prompt

Autocomplete prompt for inquirer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

inquirer-autocomplete-prompt

Autocomplete prompt for inquirer

build status dependency status

Installation

npm install --save inquirer-autocomplete-prompt

Usage

This prompt is anonymous, meaning you can register this prompt with the type name you please:

inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'));
inquirer.prompt({
  type: 'autocomplete',
  ...
})

Change autocomplete to whatever you might prefer.

Options

Note: allowed options written inside square brackets ([]) are optional. Others are required.

type, name, message, source[, filter, when]

See inquirer readme for meaning of all except source.

Source will be called with previous answers object and the current user input each time the user types, it must return a promise.

Source will be called once at at first before the user types anything with null as the value. If a new search is triggered by user input it maintains the correct order, meaning that if the first call completes after the second starts, the results of the first call are never displayed.

Example

inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'));
inquirer.prompt([{
  type: 'autocomplete',
  name: 'from',
  message: 'Select a state to travel from',
  source: function(answersSoFar, input) {
    return myApi.searchStates(input);
  }
}], function(answers) {
  //etc
});

See also example.js for a working example

Autocomplete prompt

Credits

Martin Hansen

License

ISC

About

Autocomplete prompt for inquirer

License:ISC License


Languages

Language:JavaScript 100.0%