Skip to content

Commit 337dddf

Browse files
tonyhallettmshima
andauthored
Update description of prompt (#1264)
* Update description of prompt Correct cache to store. Add that storage property can be specified as a string. Add that storage parameter is a fallback storage. * Improve description. Co-authored-by: Marcelo Shima <[email protected]>
1 parent bc08bee commit 337dddf

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -502,13 +502,13 @@ class Generator extends EventEmitter {
502502
/**
503503
* Prompt user to answer questions. The signature of this method is the same as {@link https://github.com/SBoudrias/Inquirer.js Inquirer.js}
504504
*
505-
* On top of the Inquirer.js API, you can provide a `{cache: true}` property for
505+
* On top of the Inquirer.js API, you can provide a `{store: true}` property for
506506
* every question descriptor. When set to true, Yeoman will store/fetch the
507507
* user's answers as defaults.
508508
*
509509
* @param {object|object[]} questions Array of question descriptor objects. See {@link https://github.com/SBoudrias/Inquirer.js/blob/master/README.md Documentation}
510-
* @param {Storage} [questions.storage] Store/fetch the question on the storage.
511-
* @param {Storage} [storage] Storage object
510+
* @param {Storage|String} [questions.storage] Storage object or name (generator property) to be used by the question to store/fetch the response.
511+
* @param {Storage|String} [storage] Storage object or name (generator property) to be used by default to store/fetch responses.
512512
* @return {Promise} prompt promise
513513
*/
514514
prompt(questions, storage) {

0 commit comments

Comments
 (0)