webpack 5.106.0 → 5.106.2

package/lib/CssModule.js

@@ -25,6 +25,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 class CssModule extends NormalModule {
 	/**
+	 * Creates an instance of CssModule.
 	 * @param {CSSModuleCreateData} options options object
 	 */
 	constructor(options) {
@@ -44,6 +45,7 @@ class CssModule extends NormalModule {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -85,6 +87,7 @@ class CssModule extends NormalModule {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -130,6 +133,7 @@ class CssModule extends NormalModule {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -143,6 +147,7 @@ class CssModule extends NormalModule {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {CssModule} the deserialized object
 	 */
@@ -176,6 +181,7 @@ class CssModule extends NormalModule {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/DefinePlugin.js

@@ -39,6 +39,7 @@ const createHash = require("./util/createHash");
 /** @typedef {RecursiveArrayOrRecord<CodeValuePrimitive | RuntimeValue>} CodeValue */
 
 /**
+ * Defines the runtime value options type used by this module.
  * @typedef {object} RuntimeValueOptions
  * @property {string[]=} fileDependencies
  * @property {string[]=} contextDependencies
@@ -51,6 +52,7 @@ const createHash = require("./util/createHash");
 
 class RuntimeValue {
 	/**
+	 * Creates an instance of RuntimeValue.
 	 * @param {GeneratorFn} fn generator function
 	 * @param {true | string[] | RuntimeValueOptions=} options options
 	 */
@@ -71,6 +73,7 @@ class RuntimeValue {
 	}
 
 	/**
+	 * Returns code.
 	 * @param {JavascriptParser} parser the parser
 	 * @param {ValueCacheVersions} valueCacheVersions valueCacheVersions
 	 * @param {string} key the defined key
@@ -128,6 +131,7 @@ class RuntimeValue {
 }
 
 /**
+ * Returns used keys.
  * @param {DestructuringAssignmentProperties | undefined} properties properties
  * @returns {Set<string> | undefined} used keys
  */
@@ -140,6 +144,7 @@ function getObjKeys(properties) {
 /** @typedef {boolean | undefined | null} AsiSafe */
 
 /**
+ * Returns code converted to string that evaluates.
  * @param {EXPECTED_ANY[] | { [k: string]: EXPECTED_ANY }} obj obj
  * @param {JavascriptParser} parser Parser
  * @param {ValueCacheVersions} valueCacheVersions valueCacheVersions
@@ -287,6 +292,7 @@ const toCode = (
 };
 
 /**
+ * Returns result.
  * @param {CodeValue} code code
  * @returns {string | undefined} result
  */
@@ -336,6 +342,7 @@ const WEBPACK_REQUIRE_FUNCTION_REGEXP = new RegExp(
 const WEBPACK_REQUIRE_IDENTIFIER_REGEXP = new RegExp(RuntimeGlobals.require);
 
 /**
+ * Defines the define plugin hooks type used by this module.
  * @typedef {object} DefinePluginHooks
  * @property {SyncWaterfallHook<[Record<string, CodeValue>]>} definitions
  */
@@ -347,6 +354,7 @@ const compilationHooksMap = new WeakMap();
 
 class DefinePlugin {
 	/**
+	 * Returns the attached hooks.
 	 * @param {Compilation} compilation the compilation
 	 * @returns {DefinePluginHooks} the attached hooks
 	 */
@@ -371,6 +379,7 @@ class DefinePlugin {
 	}
 
 	/**
+	 * Returns runtime value.
 	 * @param {GeneratorFn} fn generator function
 	 * @param {true | string[] | RuntimeValueOptions=} options options
 	 * @returns {RuntimeValue} runtime value
@@ -380,7 +389,7 @@ class DefinePlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -419,7 +428,7 @@ class DefinePlugin {
 				);
 
 				/**
-				 * Handler
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser Parser
 				 * @returns {void}
 				 */
@@ -440,6 +449,7 @@ class DefinePlugin {
 					});
 
 					/**
+					 * Adds value dependency.
 					 * @param {string} key key
 					 */
 					const addValueDependency = (key) => {
@@ -455,6 +465,7 @@ class DefinePlugin {
 					};
 
 					/**
+					 * With value dependency.
 					 * @template T
 					 * @param {string} key key
 					 * @param {(expression: Expression) => T} fn fn
@@ -468,7 +479,7 @@ class DefinePlugin {
 						};
 
 					/**
-					 * Walk definitions
+					 * Processes the provided definition.
 					 * @param {Definitions} definitions Definitions map
 					 * @param {string} prefix Prefix string
 					 * @returns {void}
@@ -495,7 +506,7 @@ class DefinePlugin {
 					};
 
 					/**
-					 * Apply define key
+					 * Processes the provided prefix.
 					 * @param {string} prefix Prefix
 					 * @param {string} key Key
 					 * @returns {void}
@@ -580,7 +591,7 @@ class DefinePlugin {
 					};
 
 					/**
-					 * Apply Code
+					 * Processes the provided key.
 					 * @param {string} key Key
 					 * @param {CodeValue} code Code
 					 * @returns {void}
@@ -703,7 +714,7 @@ class DefinePlugin {
 					};
 
 					/**
-					 * Apply Object
+					 * Processes the provided key.
 					 * @param {string} key Key
 					 * @param {object} obj Object
 					 * @returns {void}
@@ -788,7 +799,7 @@ class DefinePlugin {
 					.tap(PLUGIN_NAME, handler);
 
 				/**
-				 * Walk definitions
+				 * Processes the provided definition.
 				 * @param {Definitions} definitions Definitions map
 				 * @param {string} prefix Prefix string
 				 * @returns {void}
@@ -825,11 +836,13 @@ class DefinePlugin {
 				};
 
 				/**
+				 * Walk definitions for keys.
 				 * @param {Definitions} definitions Definitions map
 				 * @returns {void}
 				 */
 				const walkDefinitionsForKeys = (definitions) => {
 					/**
+					 * Adds the provided map to the define plugin.
 					 * @param {Map<string, Set<string>>} map Map
 					 * @param {string} key key
 					 * @param {string} value v

package/lib/DelegatedModule.js

@@ -47,6 +47,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {NonNullable<DllReferencePluginOptions["type"]>} DelegatedModuleType */
 
 /**
+ * Defines the delegated module data type used by this module.
  * @typedef {object} DelegatedModuleData
  * @property {BuildMeta=} buildMeta build meta
  * @property {Exports=} exports exports
@@ -60,6 +61,7 @@ const RUNTIME_REQUIREMENTS = new Set([
 
 class DelegatedModule extends Module {
 	/**
+	 * Creates an instance of DelegatedModule.
 	 * @param {DelegatedModuleSourceRequest} sourceRequest source request
 	 * @param {DelegatedModuleData} data data
 	 * @param {DelegatedModuleType} type type
@@ -83,6 +85,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -90,6 +93,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -100,6 +104,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -109,6 +114,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -117,6 +123,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -126,6 +133,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -149,6 +157,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -198,6 +207,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -206,6 +216,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -217,6 +228,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -231,6 +243,7 @@ class DelegatedModule extends Module {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context\
 	 * @returns {DelegatedModule} DelegatedModule
 	 */

package/lib/DelegatedModuleFactoryPlugin.js

@@ -16,6 +16,7 @@ const DelegatedModule = require("./DelegatedModule");
 /** @typedef {import("./util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */
 
 /**
+ * Defines the options type used by this module.
  * @typedef {object} Options
  * @property {DelegatedModuleSourceRequest} source source
  * @property {NonNullable<DllReferencePluginOptions["context"]>} context absolute context path to which lib ident is relative to
@@ -30,6 +31,7 @@ const PLUGIN_NAME = "DelegatedModuleFactoryPlugin";
 
 class DelegatedModuleFactoryPlugin {
 	/**
+	 * Creates an instance of DelegatedModuleFactoryPlugin.
 	 * @param {Options} options options
 	 */
 	constructor(options) {
@@ -39,6 +41,7 @@ class DelegatedModuleFactoryPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {NormalModuleFactory} normalModuleFactory the normal module factory
 	 * @returns {void}
 	 */

package/lib/DelegatedPlugin.js

@@ -15,6 +15,7 @@ const PLUGIN_NAME = "DelegatedPlugin";
 
 class DelegatedPlugin {
 	/**
+	 * Creates an instance of DelegatedPlugin.
 	 * @param {Options} options options
 	 */
 	constructor(options) {
@@ -22,7 +23,7 @@ class DelegatedPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/DependenciesBlock.js

@@ -53,6 +53,7 @@ class DependenciesBlock {
 	}
 
 	/**
+	 * Adds the provided dependency to the dependencies block.
 	 * @param {Dependency} dependency dependency being tied to block.
 	 * This is an "edge" pointing to another "node" on module graph.
 	 * @returns {void}
@@ -62,6 +63,7 @@ class DependenciesBlock {
 	}
 
 	/**
+	 * Removes dependency.
 	 * @param {Dependency} dependency dependency being removed
 	 * @returns {void}
 	 */
@@ -73,7 +75,7 @@ class DependenciesBlock {
 	}
 
 	/**
-	 * Removes all dependencies and blocks
+	 * Clear dependencies and blocks.
 	 * @returns {void}
 	 */
 	clearDependenciesAndBlocks() {
@@ -82,6 +84,7 @@ class DependenciesBlock {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -96,6 +99,7 @@ class DependenciesBlock {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write }) {
@@ -104,6 +108,7 @@ class DependenciesBlock {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize({ read }) {

package/lib/Dependency.js

@@ -21,6 +21,7 @@ const memoize = require("./util/memoize");
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 /** @typedef {import("./dependencies/ModuleDependency")} ModuleDependency */
 /**
+ * Defines the update hash context type used by this module.
  * @typedef {object} UpdateHashContext
  * @property {ChunkGraph} chunkGraph
  * @property {RuntimeSpec} runtime
@@ -28,12 +29,14 @@ const memoize = require("./util/memoize");
  */
 
 /**
+ * Defines the source position type used by this module.
  * @typedef {object} SourcePosition
  * @property {number} line
  * @property {number=} column
  */
 
 /**
+ * Defines the real dependency location type used by this module.
  * @typedef {object} RealDependencyLocation
  * @property {SourcePosition} start
  * @property {SourcePosition=} end
@@ -41,6 +44,7 @@ const memoize = require("./util/memoize");
  */
 
 /**
+ * Defines the synthetic dependency location type used by this module.
  * @typedef {object} SyntheticDependencyLocation
  * @property {string} name
  * @property {number=} index
@@ -51,6 +55,7 @@ const memoize = require("./util/memoize");
 /** @typedef {string} ExportInfoName */
 
 /**
+ * Defines the export spec type used by this module.
  * @typedef {object} ExportSpec
  * @property {ExportInfoName} name the name of the export
  * @property {boolean=} canMangle can the export be renamed (defaults to true)
@@ -65,6 +70,7 @@ const memoize = require("./util/memoize");
 /** @typedef {Set<string>} ExportsSpecExcludeExports */
 
 /**
+ * Defines the exports spec type used by this module.
  * @typedef {object} ExportsSpec
  * @property {(string | ExportSpec)[] | true | null} exports exported names, true for unknown exports or null for no exports
  * @property {ExportsSpecExcludeExports=} excludeExports when exports = true, list of unaffected exports
@@ -77,6 +83,7 @@ const memoize = require("./util/memoize");
  */
 
 /**
+ * Defines the referenced export type used by this module.
  * @typedef {object} ReferencedExport
  * @property {string[]} name name of the referenced export
  * @property {boolean=} canMangle when false, referenced export can not be mangled, defaults to true
@@ -124,6 +131,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns a display name for the type of dependency.
 	 * @returns {string} a display name for the type of dependency
 	 */
 	get type() {
@@ -131,6 +139,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns a dependency category, typical categories are "commonjs", "amd", "esm".
 	 * @returns {string} a dependency category, typical categories are "commonjs", "amd", "esm"
 	 */
 	get category() {
@@ -138,6 +147,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns location.
 	 * @returns {DependencyLocation} location
 	 */
 	get loc() {
@@ -183,6 +193,7 @@ class Dependency {
 	}
 
 	/**
+	 * Updates loc using the provided start line.
 	 * @param {number} startLine start line
 	 * @param {number} startColumn start column
 	 * @param {number} endLine end line
@@ -199,6 +210,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns a request context.
 	 * @returns {string | undefined} a request context
 	 */
 	getContext() {
@@ -206,6 +218,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns an identifier to merge equal requests.
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
 	getResourceIdentifier() {
@@ -213,6 +226,7 @@ class Dependency {
 	}
 
 	/**
+	 * Could affect referencing module.
 	 * @returns {boolean | TRANSITIVE} true, when changes to the referenced module could affect the referencing module; TRANSITIVE, when changes to the referenced module could affect referencing modules of the referencing module
 	 */
 	couldAffectReferencingModule() {
@@ -242,6 +256,7 @@ class Dependency {
 	}
 
 	/**
+	 * Returns function to determine if the connection is active.
 	 * @param {ModuleGraph} moduleGraph module graph
 	 * @returns {null | false | GetConditionFn} function to determine if the connection is active
 	 */
@@ -259,7 +274,7 @@ class Dependency {
 	}
 
 	/**
-	 * Returns warnings
+	 * Returns warnings.
 	 * @param {ModuleGraph} moduleGraph module graph
 	 * @returns {WebpackError[] | null | undefined} warnings
 	 */
@@ -268,7 +283,7 @@ class Dependency {
 	}
 
 	/**
-	 * Returns errors
+	 * Returns errors.
 	 * @param {ModuleGraph} moduleGraph module graph
 	 * @returns {WebpackError[] | null | undefined} errors
 	 */
@@ -277,7 +292,7 @@ class Dependency {
 	}
 
 	/**
-	 * Update the hash
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash hash to be updated
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -293,6 +308,7 @@ class Dependency {
 	}
 
 	/**
+	 * Gets module evaluation side effects state.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ConnectionState} how this dependency connects the module to referencing modules
 	 */
@@ -301,6 +317,7 @@ class Dependency {
 	}
 
 	/**
+	 * Creates an ignored module.
 	 * @param {string} context context directory
 	 * @returns {Module} ignored module
 	 */
@@ -309,6 +326,7 @@ class Dependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write }) {
@@ -323,6 +341,7 @@ class Dependency {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize({ read }) {
@@ -345,6 +364,7 @@ Dependency.EXPORTS_OBJECT_REFERENCED = [[]];
 // TODO remove in webpack 6
 Object.defineProperty(Dependency.prototype, "module", {
 	/**
+	 * Returns throws.
 	 * @deprecated
 	 * @returns {EXPECTED_ANY} throws
 	 */
@@ -355,6 +375,7 @@ Object.defineProperty(Dependency.prototype, "module", {
 	},
 
 	/**
+	 * Updates module.
 	 * @deprecated
 	 * @returns {never} throws
 	 */
@@ -366,6 +387,7 @@ Object.defineProperty(Dependency.prototype, "module", {
 });
 
 /**
+ * Returns true if the dependency is a low priority dependency.
  * @param {Dependency} dependency dep
  * @returns {boolean} true if the dependency is a low priority dependency
  */
@@ -375,6 +397,7 @@ Dependency.isLowPriorityDependency = (dependency) =>
 // TODO remove in webpack 6
 Object.defineProperty(Dependency.prototype, "disconnect", {
 	/**
+	 * Returns throws.
 	 * @deprecated
 	 * @returns {EXPECTED_ANY} throws
 	 */

package/lib/DependencyTemplate.js

@@ -19,11 +19,13 @@
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
 
 /**
+ * Defines the init fragment type used by this module.
  * @template T
  * @typedef {import("./InitFragment")<T>} InitFragment
  */
 
 /**
+ * Defines the dependency template context type used by this module.
  * @typedef {object} DependencyTemplateContext
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -39,12 +41,14 @@
  */
 
 /**
+ * Defines the css dependency template context extras type used by this module.
  * @typedef {object} CssDependencyTemplateContextExtras
  * @property {CssData} cssData the css exports data
  * @property {string} type the css exports data
  */
 
 /**
+ * Defines the css data type used by this module.
  * @typedef {object} CssData
  * @property {boolean} esModule whether export __esModule
  * @property {Map<string, string>} exports the css exports
@@ -55,6 +59,7 @@
 class DependencyTemplate {
 	/* istanbul ignore next */
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @abstract
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified

package/lib/DependencyTemplates.js

@@ -14,6 +14,7 @@ const createHash = require("./util/createHash");
 
 class DependencyTemplates {
 	/**
+	 * Creates an instance of DependencyTemplates.
 	 * @param {HashFunction} hashFunction the hash function to use
 	 */
 	constructor(hashFunction = DEFAULTS.HASH_FUNCTION) {
@@ -26,6 +27,7 @@ class DependencyTemplates {
 	}
 
 	/**
+	 * Returns template for this dependency.
 	 * @param {DependencyConstructor} dependency Constructor of Dependency
 	 * @returns {DependencyTemplate | undefined} template for this dependency
 	 */
@@ -34,6 +36,7 @@ class DependencyTemplates {
 	}
 
 	/**
+	 * Updates value using the provided dependency.
 	 * @param {DependencyConstructor} dependency Constructor of Dependency
 	 * @param {DependencyTemplate} dependencyTemplate template for this dependency
 	 * @returns {void}
@@ -43,6 +46,7 @@ class DependencyTemplates {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {string} part additional hash contributor
 	 * @returns {void}
 	 */

package/lib/DllEntryPlugin.js

@@ -19,6 +19,7 @@ const PLUGIN_NAME = "DllEntryPlugin";
 
 class DllEntryPlugin {
 	/**
+	 * Creates an instance of DllEntryPlugin.
 	 * @param {string} context context
 	 * @param {Entries} entries entry names
 	 * @param {Options} options options
@@ -30,7 +31,7 @@ class DllEntryPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */