webpack 5.106.0 → 5.106.2

package/lib/Module.js

@@ -47,6 +47,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
 /** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
 /**
+ * Defines the init fragment type used by this module.
  * @template T
  * @typedef {import("./InitFragment")<T>} InitFragment
  */
@@ -65,11 +66,13 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {"namespace" | "default-only" | "default-with-named" | "dynamic"} ExportsType */
 
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @typedef {import("./util/LazySet")<T>} LazySet<T>
  */
 
 /**
+ * Defines the source context type used by this module.
  * @typedef {object} SourceContext
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
@@ -87,6 +90,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 // TODO webpack 6: compilation will be required in CodeGenerationContext
 /**
+ * Defines the code generation context type used by this module.
  * @typedef {object} CodeGenerationContext
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
  * @property {RuntimeTemplate} runtimeTemplate the runtime template
@@ -101,6 +105,7 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
+ * Defines the concatenation bailout reason context type used by this module.
  * @typedef {object} ConcatenationBailoutReasonContext
  * @property {ModuleGraph} moduleGraph the module graph
  * @property {ChunkGraph} chunkGraph the chunk graph
@@ -110,6 +115,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {ReadonlySet<string>} ReadOnlyRuntimeRequirements */
 
 /**
+ * Defines the all code generation schemas type used by this module.
  * @typedef {object} AllCodeGenerationSchemas
  * @property {Set<string>} topLevelDeclarations top level declarations for javascript modules
  * @property {InitFragment<EXPECTED_ANY>[]} chunkInitFragments chunk init fragments for javascript modules
@@ -120,15 +126,14 @@ const makeSerializable = require("./util/makeSerializable");
  * @property {[{ shareScope: string, initStage: number, init: string }]} share-init share-init for modules federation
  */
 
-/* eslint-disable jsdoc/type-formatting */
 /**
+ * Defines the code gen value type used by this module.
  * @template {string} K
  * @typedef {K extends keyof AllCodeGenerationSchemas ? AllCodeGenerationSchemas[K] : EXPECTED_ANY} CodeGenValue
  */
-/* eslint-enable jsdoc/type-formatting */
 
-/* eslint-disable jsdoc/require-template */
 /**
+ * Defines the code gen map overloads type used by this module.
  * @typedef {object} CodeGenMapOverloads
  * @property {<K extends string>(key: K) => CodeGenValue<K> | undefined} get
  * @property {<K extends string>(key: K, value: CodeGenValue<K>) => CodeGenerationResultData} set
@@ -137,12 +142,14 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
+ * Defines the code generation result data type used by this module.
  * @typedef {Omit<Map<string, EXPECTED_ANY>, "get" | "set" | "has" | "delete"> & CodeGenMapOverloads} CodeGenerationResultData
  */
 
 /** @typedef {Map<SourceType, Source>} Sources */
 
 /**
+ * Defines the code generation result type used by this module.
  * @typedef {object} CodeGenerationResult
  * @property {Sources} sources the resulting sources for all source types
  * @property {CodeGenerationResultData=} data the resulting data for all source types
@@ -151,12 +158,14 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
+ * Defines the lib ident options type used by this module.
  * @typedef {object} LibIdentOptions
  * @property {string} context absolute context path to which lib ident is relative to
  * @property {AssociatedObjectForCache=} associatedObjectForCache object for caching
  */
 
 /**
+ * Defines the known build meta type used by this module.
  * @typedef {object} KnownBuildMeta
  * @property {("default" | "namespace" | "flagged" | "dynamic")=} exportsType
  * @property {(false | "redirect" | "redirect-warn")=} defaultObject
@@ -171,6 +180,7 @@ const makeSerializable = require("./util/makeSerializable");
  */
 
 /**
+ * Defines the known build info type used by this module.
  * @typedef {object} KnownBuildInfo
  * @property {boolean=} cacheable
  * @property {boolean=} parsed
@@ -196,6 +206,7 @@ const makeSerializable = require("./util/makeSerializable");
  * @property {boolean=} javascriptModule for external modules
  * @property {boolean=} active for lazy compilation modules
  * @property {CssData=} cssData for css modules
+ * @property {string=} charset for css modules (charset at-rule)
  * @property {JsonData=} jsonData for json modules
  * @property {Set<string>=} topLevelDeclarations top level declaration names
  */
@@ -204,6 +215,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {Map<string, ValueCacheVersion>} ValueCacheVersions */
 
 /**
+ * Defines the need build context type used by this module.
  * @typedef {object} NeedBuildContext
  * @property {Compilation} compilation
  * @property {FileSystemInfo} fileSystemInfo
@@ -218,6 +230,7 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {KnownBuildInfo & Record<string, EXPECTED_ANY>} BuildInfo */
 
 /**
+ * Defines the factory meta type used by this module.
  * @typedef {object} FactoryMeta
  * @property {boolean=} sideEffectFree
  */
@@ -231,6 +244,7 @@ const DEFAULT_TYPES_UNKNOWN = new Set([UNKNOWN_TYPE]);
 
 const deprecatedNeedRebuild = util.deprecate(
 	/**
+	 * Handles the callback logic for this hook.
 	 * @param {Module} module the module
 	 * @param {NeedBuildContext} context context info
 	 * @returns {boolean} true, when rebuild is needed
@@ -251,6 +265,7 @@ const deprecatedNeedRebuild = util.deprecate(
 
 class Module extends DependenciesBlock {
 	/**
+	 * Creates an instance of Module.
 	 * @param {ModuleTypes | ""} type the module type, when deserializing the type is not known and is an empty string
 	 * @param {(string | null)=} context an optional context
 	 * @param {(string | null)=} layer an optional layer in which the module is
@@ -305,6 +320,7 @@ class Module extends DependenciesBlock {
 	// TODO remove in webpack 6
 	// BACKWARD-COMPAT START
 	/**
+	 * Returns the module id assigned by the chunk graph.
 	 * @deprecated
 	 * @returns {ModuleId | null} module id
 	 */
@@ -317,6 +333,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Updates the module id using the provided value.
 	 * @deprecated
 	 * @param {ModuleId} value value
 	 */
@@ -333,6 +350,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the hash of the module.
 	 * @deprecated
 	 * @returns {string} the hash of the module
 	 */
@@ -345,6 +363,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the rendered hash of the module.
 	 * @deprecated
 	 * @returns {string} the shortened hash of the module
 	 */
@@ -381,6 +400,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the pre-order index.
 	 * @deprecated
 	 * @returns {number | null} the pre order index
 	 */
@@ -393,6 +413,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Updates the pre-order index using the provided value.
 	 * @deprecated
 	 * @param {number} value the pre order index
 	 */
@@ -405,6 +426,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the post-order index.
 	 * @deprecated
 	 * @returns {number | null} the post order index
 	 */
@@ -417,6 +439,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Updates the post-order index using the provided value.
 	 * @deprecated
 	 * @param {number} value the post order index
 	 */
@@ -429,6 +452,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the depth.
 	 * @deprecated
 	 * @returns {number | null} the depth
 	 */
@@ -441,6 +465,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Updates the depth using the provided value.
 	 * @deprecated
 	 * @param {number} value the depth
 	 */
@@ -453,6 +478,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the issuer.
 	 * @deprecated
 	 * @returns {Module | null | undefined} issuer
 	 */
@@ -465,6 +491,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Updates the issuer using the provided value.
 	 * @deprecated
 	 * @param {Module | null} value issuer
 	 */
@@ -489,6 +516,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets optimization bailout.
 	 * @deprecated
 	 * @returns {OptimizationBailouts} list
 	 */
@@ -515,6 +543,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds the provided chunk to the module.
 	 * @deprecated
 	 * @param {Chunk} chunk the chunk
 	 * @returns {boolean} true, when the module was added
@@ -531,6 +560,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Removes the provided chunk from the module.
 	 * @deprecated
 	 * @param {Chunk} chunk the chunk
 	 * @returns {void}
@@ -544,6 +574,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module is in the provided chunk.
 	 * @deprecated
 	 * @param {Chunk} chunk the chunk
 	 * @returns {boolean} true, when the module is in the chunk
@@ -605,6 +636,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module provides the specified export.
 	 * @deprecated
 	 * @param {string} exportName a name of an export
 	 * @returns {boolean | null} true, if the export is provided why the module.
@@ -621,6 +653,7 @@ class Module extends DependenciesBlock {
 	// BACKWARD-COMPAT END
 
 	/**
+	 * Gets exports argument.
 	 * @returns {string} name of the exports argument
 	 */
 	get exportsArgument() {
@@ -628,6 +661,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets module argument.
 	 * @returns {string} name of the module argument
 	 */
 	get moduleArgument() {
@@ -635,6 +669,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns export type.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {boolean | undefined} strict the importing module is strict
 	 * @returns {ExportsType} export type
@@ -705,6 +740,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds presentational dependency.
 	 * @param {Dependency} presentationalDependency dependency being tied to module.
 	 * This is a Dependency without edge in the module graph. It's only for presentation.
 	 * @returns {void}
@@ -717,6 +753,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds code generation dependency.
 	 * @param {Dependency} codeGenerationDependency dependency being tied to module.
 	 * This is a Dependency where the code generation result of the referenced module is needed during code generation.
 	 * The Dependency should also be added to normal dependencies via addDependency.
@@ -730,7 +767,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
-	 * Removes all dependencies and blocks
+	 * Clear dependencies and blocks.
 	 * @returns {void}
 	 */
 	clearDependenciesAndBlocks() {
@@ -744,6 +781,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds the provided warning to the module.
 	 * @param {WebpackError} warning the warning
 	 * @returns {void}
 	 */
@@ -755,6 +793,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns list of warnings if any.
 	 * @returns {Iterable<WebpackError> | undefined} list of warnings if any
 	 */
 	getWarnings() {
@@ -762,6 +801,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets number of warnings.
 	 * @returns {number} number of warnings
 	 */
 	getNumberOfWarnings() {
@@ -769,6 +809,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds the provided error to the module.
 	 * @param {WebpackError} error the error
 	 * @returns {void}
 	 */
@@ -780,6 +821,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns list of errors if any.
 	 * @returns {Iterable<WebpackError> | undefined} list of errors if any
 	 */
 	getErrors() {
@@ -787,6 +829,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets number of errors.
 	 * @returns {number} number of errors
 	 */
 	getNumberOfErrors() {
@@ -807,6 +850,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module is optional.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {boolean} true, if the module is optional
 	 */
@@ -826,6 +870,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module is accessible in chunk.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {Chunk} chunk a chunk
 	 * @param {Chunk=} ignoreChunk chunk to be ignored
@@ -840,6 +885,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module is accessible in chunk group.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {ChunkGroup} chunkGroup a chunk group
 	 * @param {Chunk=} ignoreChunk chunk to be ignored
@@ -867,6 +913,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module contains the chunk.
 	 * @param {Chunk} chunk a chunk
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ChunkGraph} chunkGraph the chunk graph
@@ -892,6 +939,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether this module contains the module graph.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true if at least one other module depends on this module
@@ -904,6 +952,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns a string representation.
 	 * @returns {string} for debugging
 	 */
 	toString() {
@@ -911,6 +960,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * 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}
@@ -925,6 +975,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Checks whether it needs rebuild.
 	 * @deprecated Use needBuild instead
 	 * @param {Map<string, number | null>} fileTimestamps timestamps of files
 	 * @param {Map<string, number | null>} contextTimestamps timestamps of directories
@@ -935,6 +986,7 @@ class Module extends 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}
@@ -961,6 +1013,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Invalidates the cached state associated with this value.
 	 * @returns {void}
 	 */
 	invalidateBuild() {
@@ -969,6 +1022,7 @@ class Module extends DependenciesBlock {
 
 	/* istanbul ignore next */
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @abstract
 	 * @returns {string} a unique identifier of the module
 	 */
@@ -980,6 +1034,7 @@ class Module extends DependenciesBlock {
 
 	/* istanbul ignore next */
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @abstract
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
@@ -992,6 +1047,7 @@ class Module extends DependenciesBlock {
 
 	/* istanbul ignore next */
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @abstract
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
@@ -1007,6 +1063,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @abstract
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
@@ -1032,6 +1089,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns generated source.
 	 * @abstract
 	 * @deprecated Use codeGeneration() instead
 	 * @param {DependencyTemplates} dependencyTemplates the dependency templates
@@ -1071,6 +1129,7 @@ class Module extends DependenciesBlock {
 
 	/* istanbul ignore next */
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @abstract
 	 * @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)
@@ -1082,6 +1141,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -1090,6 +1150,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the path used when matching this module against rule conditions.
 	 * @returns {NameForCondition | null} absolute path which should be used for condition matching (usually the resource path)
 	 */
 	nameForCondition() {
@@ -1097,6 +1158,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns the reason this module cannot be concatenated, when one exists.
 	 * @param {ConcatenationBailoutReasonContext} context context
 	 * @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
 	 */
@@ -1105,6 +1167,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets side effects connection state.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only
 	 */
@@ -1113,6 +1176,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -1143,6 +1207,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Returns true if the module can be placed in the chunk.
 	 * @param {Chunk} chunk the chunk which condition should be checked
 	 * @param {Compilation} compilation the compilation
 	 * @returns {boolean} true if the module can be placed in the chunk
@@ -1201,6 +1266,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Gets the original source.
 	 * @returns {Source | null} the original source for the module before webpack transformation
 	 */
 	originalSource() {
@@ -1208,6 +1274,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Adds the provided file dependencies to the module.
 	 * @param {FileSystemDependencies} fileDependencies set where file dependencies are added to
 	 * @param {FileSystemDependencies} contextDependencies set where context dependencies are added to
 	 * @param {FileSystemDependencies} missingDependencies set where missing dependencies are added to
@@ -1221,6 +1288,7 @@ class Module extends DependenciesBlock {
 	) {}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -1251,6 +1319,7 @@ class Module extends DependenciesBlock {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -1274,6 +1343,7 @@ class Module extends DependenciesBlock {
 
 	// TODO remove in webpack 6
 	/**
+	 * Gets source basic types.
 	 * @deprecated In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method.
 	 * @param {Module} module the module
 	 * @returns {ReturnType<Module["getSourceBasicTypes"]>} the source types of the module
@@ -1293,6 +1363,7 @@ makeSerializable(Module, "webpack/lib/Module");
 // TODO remove in webpack 6
 Object.defineProperty(Module.prototype, "hasEqualsChunks", {
 	/**
+	 * Gets has equals chunks.
 	 * @deprecated
 	 * @returns {EXPECTED_ANY} throw an error
 	 */
@@ -1306,6 +1377,7 @@ Object.defineProperty(Module.prototype, "hasEqualsChunks", {
 // TODO remove in webpack 6
 Object.defineProperty(Module.prototype, "isUsed", {
 	/**
+	 * Returns throw an error.
 	 * @deprecated
 	 * @returns {EXPECTED_ANY} throw an error
 	 */
@@ -1319,11 +1391,13 @@ Object.defineProperty(Module.prototype, "isUsed", {
 // TODO remove in webpack 6
 Object.defineProperty(Module.prototype, "errors", {
 	/**
+	 * Returns errors.
 	 * @deprecated
 	 * @returns {WebpackError[]} errors
 	 */
 	get: util.deprecate(
 		/**
+		 * Returns errors.
 		 * @this {Module}
 		 * @returns {WebpackError[]} errors
 		 */
@@ -1341,11 +1415,13 @@ Object.defineProperty(Module.prototype, "errors", {
 // TODO remove in webpack 6
 Object.defineProperty(Module.prototype, "warnings", {
 	/**
+	 * Returns warnings.
 	 * @deprecated
 	 * @returns {WebpackError[]} warnings
 	 */
 	get: util.deprecate(
 		/**
+		 * Returns warnings.
 		 * @this {Module}
 		 * @returns {WebpackError[]} warnings
 		 */
@@ -1363,6 +1439,7 @@ Object.defineProperty(Module.prototype, "warnings", {
 // TODO remove in webpack 6
 Object.defineProperty(Module.prototype, "used", {
 	/**
+	 * Returns throw an error.
 	 * @deprecated
 	 * @returns {EXPECTED_ANY} throw an error
 	 */
@@ -1372,6 +1449,7 @@ Object.defineProperty(Module.prototype, "used", {
 		);
 	},
 	/**
+	 * Updates used using the provided value.
 	 * @param {EXPECTED_ANY} value value
 	 */
 	set(value) {

package/lib/ModuleBuildError.js

@@ -16,6 +16,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 class ModuleBuildError extends WebpackError {
 	/**
+	 * Creates an instance of ModuleBuildError.
 	 * @param {string | ErrorWithHideStack} err error thrown
 	 * @param {{ from?: string | null }} info additional info
 	 */
@@ -56,6 +57,7 @@ class ModuleBuildError extends WebpackError {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -67,6 +69,7 @@ class ModuleBuildError extends WebpackError {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/ModuleDependencyWarning.js

@@ -14,6 +14,7 @@ const makeSerializable = require("./util/makeSerializable");
 
 class ModuleDependencyWarning extends WebpackError {
 	/**
+	 * Creates an instance of ModuleDependencyWarning.
 	 * @param {Module} module module tied to dependency
 	 * @param {ErrorWithHideStack} err error thrown
 	 * @param {DependencyLocation} loc location of dependency

package/lib/ModuleError.js

@@ -42,6 +42,7 @@ class ModuleError extends WebpackError {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -53,6 +54,7 @@ class ModuleError extends WebpackError {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/ModuleFactory.js

@@ -10,6 +10,7 @@
 /** @typedef {import("./Module")} Module */
 
 /**
+ * Defines the module factory result type used by this module.
  * @typedef {object} ModuleFactoryResult
  * @property {Module=} module the created module or unset if no module was created
  * @property {Set<string>=} fileDependencies
@@ -21,6 +22,7 @@
 /** @typedef {string | null} IssuerLayer */
 
 /**
+ * Defines the module factory create data context info type used by this module.
  * @typedef {object} ModuleFactoryCreateDataContextInfo
  * @property {string} issuer
  * @property {IssuerLayer} issuerLayer
@@ -28,6 +30,7 @@
  */
 
 /**
+ * Defines the module factory create data type used by this module.
  * @typedef {object} ModuleFactoryCreateData
  * @property {ModuleFactoryCreateDataContextInfo} contextInfo
  * @property {ResolveOptions=} resolveOptions
@@ -36,12 +39,14 @@
  */
 
 /**
+ * Represents the module factory runtime component.
  * @typedef {(err?: Error | null, result?: ModuleFactoryResult) => void} ModuleFactoryCallback
  */
 
 class ModuleFactory {
 	/* istanbul ignore next */
 	/**
+	 * Processes the provided data.
 	 * @abstract
 	 * @param {ModuleFactoryCreateData} data data object
 	 * @param {ModuleFactoryCallback} callback callback