Skip to content

Commit

Permalink
docs: fix JSDoc field for object parameter templateParams in Generato…
Browse files Browse the repository at this point in the history
…r constructor (#999)
  • Loading branch information
imballinst authored Jun 28, 2023
1 parent 9d29c69 commit e3b731b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/generator.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class Generator {
* @param {String} templateName Name of the template to generate.
* @param {String} targetDir Path to the directory where the files will be generated.
* @param {Object} options
* @param {String} [options.templateParams] Optional parameters to pass to the template. Each template define their own params.
* @param {Object<string, string>} [options.templateParams] Optional parameters to pass to the template. Each template define their own params.
* @param {String} [options.entrypoint] Name of the file to use as the entry point for the rendering process. Use in case you want to use only a specific template file. Note: this potentially avoids rendering every file in the template.
* @param {String[]} [options.noOverwriteGlobs] List of globs to skip when regenerating the template.
* @param {Object<String, Boolean | String | String[]>} [options.disabledHooks] Object with hooks to disable. The key is a hook type. If key has "true" value, then the generator skips all hooks from the given type. If the value associated with a key is a string with the name of a single hook, then the generator skips only this single hook name. If the value associated with a key is an array of strings, then the generator skips only hooks from the array.
Expand Down

0 comments on commit e3b731b

Please sign in to comment.