webpack 5.106.0 → 5.106.2

package/lib/Chunk.js

@@ -37,6 +37,7 @@ const { mergeRuntime } = require("./util/runtime");
 const ChunkFilesSet = createArrayToSetDeprecationSet("chunk.files");
 
 /**
+ * Defines the chunk maps type used by this module.
  * @deprecated
  * @typedef {object} ChunkMaps
  * @property {Record<ChunkId, string>} hash
@@ -45,16 +46,19 @@ const ChunkFilesSet = createArrayToSetDeprecationSet("chunk.files");
  */
 
 /**
+ * Defines the chunk module id map type used by this module.
  * @deprecated
  * @typedef {Record<ChunkId, ChunkId[]>} ChunkModuleIdMap
  */
 
 /**
+ * Defines the chunk module hash map type used by this module.
  * @deprecated
  * @typedef {Record<ModuleId, string>} chunkModuleHashMap
  */
 
 /**
+ * Defines the chunk module maps type used by this module.
  * @deprecated
  * @typedef {object} ChunkModuleMaps
  * @property {ChunkModuleIdMap} id
@@ -77,6 +81,7 @@ let debugId = 1000;
  */
 class Chunk {
 	/**
+	 * Creates an instance of Chunk.
 	 * @param {ChunkName=} name of chunk being created, is optional (for subclasses)
 	 * @param {boolean} backCompat enable backward-compatibility
 	 */
@@ -125,6 +130,7 @@ class Chunk {
 	// TODO remove in webpack 6
 	// BACKWARD-COMPAT START
 	/**
+	 * Returns entry module.
 	 * @deprecated
 	 * @returns {Module | undefined} entry module
 	 */
@@ -148,6 +154,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk has an entry module.
 	 * @deprecated
 	 * @returns {boolean} true, if the chunk contains an entry module
 	 */
@@ -162,6 +169,7 @@ class Chunk {
 	}
 
 	/**
+	 * Adds the provided module to the chunk.
 	 * @deprecated
 	 * @param {Module} module the module
 	 * @returns {boolean} true, if the chunk could be added
@@ -178,6 +186,7 @@ class Chunk {
 	}
 
 	/**
+	 * Removes the provided module from the chunk.
 	 * @deprecated
 	 * @param {Module} module the module
 	 * @returns {void}
@@ -191,6 +200,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets the number of modules in this chunk.
 	 * @deprecated
 	 * @returns {number} the number of module which are contained in this chunk
 	 */
@@ -219,6 +229,7 @@ class Chunk {
 	}
 
 	/**
+	 * Compares this chunk with another chunk.
 	 * @deprecated
 	 * @param {Chunk} otherChunk the chunk to compare with
 	 * @returns {-1 | 0 | 1} the comparison result
@@ -233,6 +244,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk contains the module.
 	 * @deprecated
 	 * @param {Module} module the module
 	 * @returns {boolean} true, if the chunk contains the module
@@ -246,6 +258,7 @@ class Chunk {
 	}
 
 	/**
+	 * Returns the modules for this chunk.
 	 * @deprecated
 	 * @returns {Module[]} the modules for this chunk
 	 */
@@ -258,6 +271,7 @@ class Chunk {
 	}
 
 	/**
+	 * Removes this chunk from the chunk graph and chunk groups.
 	 * @deprecated
 	 * @returns {void}
 	 */
@@ -272,6 +286,7 @@ class Chunk {
 	}
 
 	/**
+	 * Moves a module from this chunk to another chunk.
 	 * @deprecated
 	 * @param {Module} module the module
 	 * @param {Chunk} otherChunk the target chunk
@@ -288,6 +303,7 @@ class Chunk {
 	}
 
 	/**
+	 * Integrates another chunk into this chunk when possible.
 	 * @deprecated
 	 * @param {Chunk} otherChunk the other chunk
 	 * @returns {boolean} true, if the specified chunk has been integrated
@@ -307,6 +323,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk can be integrated with another chunk.
 	 * @deprecated
 	 * @param {Chunk} otherChunk the other chunk
 	 * @returns {boolean} true, if chunks could be integrated
@@ -321,6 +338,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk is empty.
 	 * @deprecated
 	 * @returns {boolean} true, if this chunk contains no module
 	 */
@@ -334,6 +352,7 @@ class Chunk {
 	}
 
 	/**
+	 * Returns the total size of all modules in this chunk.
 	 * @deprecated
 	 * @returns {number} total size of all modules in this chunk
 	 */
@@ -347,6 +366,7 @@ class Chunk {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @deprecated
 	 * @param {ChunkSizeOptions} options options object
 	 * @returns {number} total size of this chunk
@@ -361,6 +381,7 @@ class Chunk {
 	}
 
 	/**
+	 * Returns the integrated size with another chunk.
 	 * @deprecated
 	 * @param {Chunk} otherChunk the other chunk
 	 * @param {ChunkSizeOptions} options options object
@@ -376,6 +397,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets chunk module maps.
 	 * @deprecated
 	 * @param {ModuleFilterPredicate} filterFn function used to filter modules
 	 * @returns {ChunkModuleMaps} module map information
@@ -422,6 +444,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk contains a matching module in the graph.
 	 * @deprecated
 	 * @param {ModuleFilterPredicate} filterFn predicate function used to filter modules
 	 * @param {ChunkFilterPredicate=} filterChunkFn predicate function used to filter chunks
@@ -437,6 +460,7 @@ class Chunk {
 	}
 
 	/**
+	 * Returns the chunk map information.
 	 * @deprecated
 	 * @param {boolean} realHash whether the full hash or the rendered hash is to be used
 	 * @returns {ChunkMaps} the chunk map information
@@ -474,6 +498,7 @@ class Chunk {
 	// BACKWARD-COMPAT END
 
 	/**
+	 * Checks whether this chunk has runtime.
 	 * @returns {boolean} whether or not the Chunk will have a runtime
 	 */
 	hasRuntime() {
@@ -489,6 +514,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether it can be initial.
 	 * @returns {boolean} whether or not this chunk can be an initial chunk
 	 */
 	canBeInitial() {
@@ -499,6 +525,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk is only initial.
 	 * @returns {boolean} whether this chunk can only be an initial chunk
 	 */
 	isOnlyInitial() {
@@ -510,6 +537,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets entry options.
 	 * @returns {EntryOptions | undefined} the entry options for this chunk
 	 */
 	getEntryOptions() {
@@ -522,6 +550,7 @@ class Chunk {
 	}
 
 	/**
+	 * Adds the provided chunk group to the chunk.
 	 * @param {ChunkGroup} chunkGroup the chunkGroup the chunk is being added
 	 * @returns {void}
 	 */
@@ -530,6 +559,7 @@ class Chunk {
 	}
 
 	/**
+	 * Removes the provided chunk group from the chunk.
 	 * @param {ChunkGroup} chunkGroup the chunkGroup the chunk is being removed from
 	 * @returns {void}
 	 */
@@ -538,6 +568,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk is in group.
 	 * @param {ChunkGroup} chunkGroup the chunkGroup to check
 	 * @returns {boolean} returns true if chunk has chunkGroup reference and exists in chunkGroup
 	 */
@@ -546,6 +577,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets number of groups.
 	 * @returns {number} the amount of groups that the said chunk is in
 	 */
 	getNumberOfGroups() {
@@ -553,6 +585,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets groups iterable.
 	 * @returns {SortableChunkGroups} the chunkGroups that the said chunk is referenced in
 	 */
 	get groupsIterable() {
@@ -561,6 +594,7 @@ class Chunk {
 	}
 
 	/**
+	 * Disconnects from groups.
 	 * @returns {void}
 	 */
 	disconnectFromGroups() {
@@ -570,6 +604,7 @@ class Chunk {
 	}
 
 	/**
+	 * Processes the provided new chunk.
 	 * @param {Chunk} newChunk the new chunk that will be split out of
 	 * @returns {void}
 	 */
@@ -585,6 +620,7 @@ class Chunk {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash hash (will be modified)
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @returns {void}
@@ -610,6 +646,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets all async chunks.
 	 * @returns {Chunks} a set of all the async chunks
 	 */
 	getAllAsyncChunks() {
@@ -650,6 +687,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets all initial chunks.
 	 * @returns {Chunks} a set of all the initial chunks (including itself)
 	 */
 	getAllInitialChunks() {
@@ -667,6 +705,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets all referenced chunks.
 	 * @returns {Chunks} a set of all the referenced chunks (including itself)
 	 */
 	getAllReferencedChunks() {
@@ -688,6 +727,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets all referenced async entrypoints.
 	 * @returns {Entrypoints} a set of all the referenced entrypoints
 	 */
 	getAllReferencedAsyncEntrypoints() {
@@ -709,6 +749,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk has async chunks.
 	 * @returns {boolean} true, if the chunk references async chunks
 	 */
 	hasAsyncChunks() {
@@ -740,6 +781,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets child ids by orders.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {ChunkFilterPredicate=} filterFn function used to filter chunks
 	 * @returns {Record<string, ChunkId[]>} a record object of names to lists of child ids(?)
@@ -798,6 +840,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets children of type in order.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {string} type option name
 	 * @returns {ChunkChildOfTypeInOrder[] | undefined} referenced chunks for a specific type
@@ -846,6 +889,7 @@ class Chunk {
 	}
 
 	/**
+	 * Gets child ids by orders map.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {boolean=} includeDirectChildren include direct children (by default only children of async children are included)
 	 * @param {ChunkFilterPredicate=} filterFn function used to filter chunks
@@ -856,6 +900,7 @@ class Chunk {
 		const chunkMaps = Object.create(null);
 
 		/**
+		 * Adds child ids by orders to map.
 		 * @param {Chunk} chunk a chunk
 		 * @returns {void}
 		 */
@@ -891,6 +936,7 @@ class Chunk {
 	}
 
 	/**
+	 * Checks whether this chunk contains the chunk graph.
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {string} type option name
 	 * @param {boolean=} includeDirectChildren include direct children (by default only children of async children are included)