webpack 5.106.1 → 5.106.2

package/lib/javascript/BasicEvaluatedExpression.js

@@ -185,7 +185,7 @@ class BasicEvaluatedExpression {
 	}
 
 	/**
-	 * Gets the compile-time value of the expression
+	 * As compile time value.
 	 * @returns {undefined | null | string | number | boolean | RegExp | EXPECTED_ANY[] | bigint} the javascript value
 	 */
 	asCompileTimeValue() {
@@ -322,6 +322,7 @@ class BasicEvaluatedExpression {
 	}
 
 	/**
+	 * Updates string using the provided string.
 	 * @param {string} string value
 	 * @returns {BasicEvaluatedExpression} basic evaluated expression
 	 */
@@ -447,7 +448,7 @@ class BasicEvaluatedExpression {
 	}
 
 	/**
-	 * Adds options to a conditional expression.
+	 * Adds the provided basic evaluated expression to the basic evaluated expression.
 	 * @param {BasicEvaluatedExpression[]} options optional (consequent/alternate) expressions to be added
 	 * @returns {this} this
 	 */
@@ -562,6 +563,7 @@ class BasicEvaluatedExpression {
 }
 
 /**
+ * Returns is valid flags.
  * @param {string} flags regexp flags
  * @returns {boolean} is valid flags
  */

package/lib/javascript/ChunkFormatHelpers.js

@@ -15,7 +15,7 @@ const { updateHashForEntryStartup } = require("./StartupHelpers");
 /** @typedef {import("../Compilation").ChunkHashContext} ChunkHashContext */
 
 /**
- * Gets information about a chunk including its entries and runtime chunk
+ * Returns } Object containing chunk entries and runtime chunk.
  * @param {Chunk} chunk The chunk to get information for
  * @param {ChunkGraph} chunkGraph The chunk graph containing the chunk
  * @returns {{ entries: [Module, Entrypoint | undefined][], runtimeChunk: Chunk | null }} Object containing chunk entries and runtime chunk
@@ -43,6 +43,7 @@ function getChunkInfo(chunk, chunkGraph) {
  */
 function createChunkHashHandler(name) {
 	/**
+	 * Processes the provided chunk.
 	 * @param {Chunk} chunk The chunk to get information for
 	 * @param {Hash} hash The hash to update
 	 * @param {ChunkHashContext} chunkHashContext The chunk hash context

package/lib/javascript/ChunkHelpers.js

@@ -10,6 +10,7 @@ const Entrypoint = require("../Entrypoint");
 /** @typedef {import("../Chunk")} Chunk */
 
 /**
+ * Returns chunks.
  * @param {Entrypoint} entrypoint a chunk group
  * @param {(Chunk | null)=} excludedChunk1 current chunk which is excluded
  * @param {(Chunk | null)=} excludedChunk2 runtime chunk which is excluded

package/lib/javascript/CommonJsChunkFormatPlugin.js

@@ -26,7 +26,7 @@ const PLUGIN_NAME = "CommonJsChunkFormatPlugin";
 
 class CommonJsChunkFormatPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/javascript/EnableChunkLoadingPlugin.js

@@ -14,6 +14,7 @@
 const enabledTypes = new WeakMap();
 
 /**
+ * Returns enabled types.
  * @param {Compiler} compiler compiler
  * @returns {ChunkLoadingTypes} enabled types
  */
@@ -29,6 +30,7 @@ const getEnabledTypes = (compiler) => {
 
 class EnableChunkLoadingPlugin {
 	/**
+	 * Creates an instance of EnableChunkLoadingPlugin.
 	 * @param {ChunkLoadingType} type library type that should be available
 	 */
 	constructor(type) {
@@ -36,6 +38,7 @@ class EnableChunkLoadingPlugin {
 	}
 
 	/**
+	 * Updates enabled using the provided compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @param {ChunkLoadingType} type type of library
 	 * @returns {void}
@@ -45,6 +48,7 @@ class EnableChunkLoadingPlugin {
 	}
 
 	/**
+	 * Checks enabled.
 	 * @param {Compiler} compiler the compiler instance
 	 * @param {ChunkLoadingType} type type of library
 	 * @returns {void}
@@ -62,7 +66,7 @@ class EnableChunkLoadingPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/javascript/JavascriptGenerator.js

@@ -30,6 +30,7 @@ const DEFAULT_SOURCE = {
 		return new RawSource("throw new Error('No source available');");
 	},
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @returns {number} size of the DEFAULT_SOURCE.source()
 	 */
 	size() {
@@ -42,6 +43,7 @@ const DEFAULT_SOURCE = {
 
 const deprecatedGetInitFragments = util.deprecate(
 	/**
+	 * Handles the callback logic for this hook.
 	 * @param {DependencyTemplate} template template
 	 * @param {Dependency} dependency dependency
 	 * @param {DependencyTemplateContext} templateContext template context
@@ -56,6 +58,7 @@ const deprecatedGetInitFragments = util.deprecate(
 
 class JavascriptGenerator extends Generator {
 	/**
+	 * Returns the source types available for this module.
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
@@ -64,6 +67,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
@@ -77,6 +81,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the reason this module cannot be concatenated, when one exists.
 	 * @param {NormalModule} module module for which the bailout reason should be determined
 	 * @param {ConcatenationBailoutReasonContext} context context
 	 * @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
@@ -103,6 +108,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Processes the provided module.
 	 * @param {Module} module the current module
 	 * @param {Dependency} dependency the dependency to generate
 	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
@@ -173,6 +179,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Processes the provided module.
 	 * @param {Module} module the module to generate
 	 * @param {DependenciesBlock} block the dependencies block which will be processed
 	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
@@ -203,6 +210,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Processes the provided module.
 	 * @param {Module} module the module to generate
 	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
 	 * @param {ReplaceSource} source the current replace source which can be modified
@@ -244,6 +252,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates generated code for this runtime module.
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
 	 * @returns {Source | null} generated code
@@ -264,6 +273,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates fallback output for the provided error condition.
 	 * @param {Error} error the error
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate

package/lib/javascript/JavascriptModulesPlugin.js

@@ -80,6 +80,7 @@ const JavascriptParser = require("./JavascriptParser");
 const chunkHasJsCache = new WeakMap();
 
 /**
+ * Returns true, when a JS file is needed for this chunk.
  * @param {Chunk} chunk a chunk
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @returns {boolean} true, when a JS file is needed for this chunk
@@ -99,6 +100,7 @@ const _chunkHasJs = (chunk, chunkGraph) => {
 };
 
 /**
+ * Returns true, when a JS file is needed for this chunk.
  * @param {Chunk} chunk a chunk
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @returns {boolean} true, when a JS file is needed for this chunk
@@ -121,6 +123,7 @@ const chunkHasJs = (chunk, chunkGraph) => {
 };
 
 /**
+ * Chunk has runtime or js.
  * @param {Chunk} chunk a chunk
  * @param {ChunkGraph} chunkGraph the chunk graph
  * @returns {boolean} true, when a JS file is needed for this chunk
@@ -148,6 +151,7 @@ const chunkHasRuntimeOrJs = (chunk, chunkGraph) => {
 };
 
 /**
+ * Print generated code for stack.
  * @param {Module} module a module
  * @param {string} code the code
  * @returns {string} generated code for the stack
@@ -158,6 +162,7 @@ const printGeneratedCodeForStack = (module, code) => {
 	return `\n\nGenerated code for ${module.identifier()}\n${lines
 		.map(
 			/**
+			 * Handles the callback logic for this hook.
 			 * @param {string} line the line
 			 * @param {number} i the index
 			 * @param {string[]} _lines the lines
@@ -172,6 +177,7 @@ const printGeneratedCodeForStack = (module, code) => {
 };
 
 /**
+ * Defines the render context type used by this module.
  * @typedef {object} RenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -183,6 +189,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the main render context type used by this module.
  * @typedef {object} MainRenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -195,6 +202,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the chunk render context type used by this module.
  * @typedef {object} ChunkRenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -207,6 +215,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the render bootstrap context type used by this module.
  * @typedef {object} RenderBootstrapContext
  * @property {Chunk} chunk the chunk
  * @property {CodeGenerationResults} codeGenerationResults results of code generation
@@ -217,6 +226,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the startup render context type used by this module.
  * @typedef {object} StartupRenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -231,6 +241,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the module render context type used by this module.
  * @typedef {object} ModuleRenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -246,6 +257,7 @@ const printGeneratedCodeForStack = (module, code) => {
  */
 
 /**
+ * Defines the compilation hooks type used by this module.
  * @typedef {object} CompilationHooks
  * @property {SyncWaterfallHook<[Source, Module, ModuleRenderContext]>} renderModuleContent
  * @property {SyncWaterfallHook<[Source, Module, ModuleRenderContext]>} renderModuleContainer
@@ -272,6 +284,7 @@ const PLUGIN_NAME = "JavascriptModulesPlugin";
 
 class JavascriptModulesPlugin {
 	/**
+	 * Returns the attached hooks.
 	 * @param {Compilation} compilation the compilation
 	 * @returns {CompilationHooks} the attached hooks
 	 */
@@ -327,7 +340,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -642,6 +655,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Gets chunk filename template.
 	 * @param {Chunk} chunk chunk
 	 * @param {OutputOptions} outputOptions output options
 	 * @returns {TemplatePath} used filename template
@@ -658,6 +672,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Renders the newly generated source from rendering.
 	 * @param {Module} module the rendered module
 	 * @param {ModuleRenderContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks
@@ -797,6 +812,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Renders the rendered source.
 	 * @param {RenderContext} renderContext the render context
 	 * @param {CompilationHooks} hooks hooks
 	 * @returns {Source} the rendered source
@@ -875,6 +891,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Renders the newly generated source from rendering.
 	 * @param {MainRenderContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks
 	 * @param {Compilation} compilation the compilation
@@ -1240,6 +1257,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Updates hash with bootstrap.
 	 * @param {Hash} hash the hash to be updated
 	 * @param {RenderBootstrapContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks
@@ -1260,6 +1278,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Renders the generated source of the bootstrap code.
 	 * @param {RenderBootstrapContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks
 	 * @returns {Bootstrap} the generated source of the bootstrap code
@@ -1605,6 +1624,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Renders the generated source of the require function.
 	 * @param {RenderBootstrapContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks
 	 * @returns {string} the generated source of the require function
@@ -1618,6 +1638,7 @@ class JavascriptModulesPlugin {
 		const runtimeRequirements = chunkGraph.getTreeRuntimeRequirements(chunk);
 
 		/**
+		 * Renders missing module error.
 		 * @param {string} condition guard expression
 		 * @returns {string[]} source
 		 */
@@ -1742,6 +1763,7 @@ class JavascriptModulesPlugin {
 	}
 
 	/**
+	 * Get renamed inline module.
 	 * @param {Compilation} compilation compilation
 	 * @param {Module[]} allModules allModules
 	 * @param {MainRenderContext} renderContext renderContext