Skip to content

Commit

Permalink
[docs] clarification about prompt method. (#995)
Browse files Browse the repository at this point in the history
  • Loading branch information
knoid authored Feb 25, 2021
1 parent eb6e7d0 commit eae985f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,12 @@ node packages/inquirer/examples/checkbox.js

<a name="methods"></a>

#### `inquirer.prompt(questions) -> promise`
#### `inquirer.prompt(questions, answers) -> promise`

Launch the prompt interface (inquiry session)

- **questions** (Array) containing [Question Object](#question) (using the [reactive interface](#reactive-interface), you can also pass a `Rx.Observable` instance)
- **answers** (object) contains values of already answered questions. Inquirer will avoid asking answers already provided here. Defaults `{}`.
- returns a **Promise**

#### `inquirer.registerPrompt(name, prompt)`
Expand Down

0 comments on commit eae985f

Please sign in to comment.