fix(types): fix typo, had type getRenderManifest to ensure proper call signatures for chunk and main templates

TheLarkInn · TheLarkInn · commit fdcafe6614f8 · 2018-05-01T10:47:14.000-05:00
diff --git a/lib/ChunkTemplate.js b/lib/ChunkTemplate.js
@@ -6,6 +6,21 @@
 
 const { Tapable, SyncWaterfallHook, SyncHook } = require("tapable");
 
+/** @typedef {import("./ModuleTemplate")} ModuleTemplate */
+/** @typedef {import("./Chunk")} Chunk */
+/** @typedef {import("./Module")} Module} */
+/** @typedef {import("crypto").Hash} Hash */
+
+/**
+ * @typedef {Object} RenderManifestOptions
+ * @property {Chunk} chunk the chunk used to render
+ * @property {Hash} hash
+ * @property {string} fullHash
+ * @property {any} outputOptions
+ * @property {{javascript: ModuleTemplate, webassembly: ModuleTemplate}} moduleTemplates
+ * @property {Map} dependencyTemplates
+ */
+
 module.exports = class ChunkTemplate extends Tapable {
 	constructor(outputOptions) {
 		super();
@@ -30,6 +45,11 @@ module.exports = class ChunkTemplate extends Tapable {
 		};
 	}
 
+	/**
+	 *
+	 * @param {RenderManifestOptions} options render manifest options
+	 * @returns {any[]} returns render manifest
+	 */
 	getRenderManifest(options) {
 		const result = [];
 
diff --git a/lib/MainTemplate.js b/lib/MainTemplate.js
@@ -18,11 +18,21 @@ const {
 } = require("tapable");
 const Template = require("./Template");
 
-/** @typedef {import("tapable").Hook} Hook */
 /** @typedef {import("webpack-sources").ConcatSource} ConcatSource */
 /** @typedef {import("./ModuleTemplate")} ModuleTemplate */
 /** @typedef {import("./Chunk")} Chunk */
 /** @typedef {import("./Module")} Module} */
+/** @typedef {import("crypto").Hash} Hash} */
+
+/**
+ * @typedef {Object} RenderManifestOptions
+ * @property {Chunk} chunk the chunk used to render
+ * @property {Hash} hash
+ * @property {string} fullHash
+ * @property {any} outputOptions
+ * @property {{javascript: ModuleTemplate, webassembly: ModuleTemplate}} moduleTemplates
+ * @property {Map} dependencyTemplates
+ */
 
 // require function shortcuts:
 // __webpack_require__.s = the module id of the entry point
@@ -49,8 +59,8 @@ module.exports = class MainTemplate extends Tapable {
 		super();
 		/** @type {any?} */
 		this.outputOptions = outputOptions || {};
-		/** @type {{[hookName: string]: Hook}} */
 		this.hooks = {
+			/** @type {SyncWaterfallHook<any[], RenderManifestOptions>} */
 			renderManifest: new SyncWaterfallHook(["result", "options"]),
 			modules: new SyncWaterfallHook([
 				"modules",
@@ -311,8 +321,8 @@ module.exports = class MainTemplate extends Tapable {
 
 	/**
 	 *
-	 * @param {any} options render manifest options
-	 * @returns {any[]} returns render nanifest
+	 * @param {RenderManifestOptions} options render manifest options
+	 * @returns {any[]} returns render manifest
 	 */
 	getRenderManifest(options) {
 		const result = [];
