Merge pull request webpack#7195 from webpack/feature/type-graph-helpers

chore(types): add types to GraphHelpers

Author: TheLarkInn

lib/DependenciesBlock.js

@@ -6,11 +6,15 @@
 
 const DependenciesBlockVariable = require("./DependenciesBlockVariable");
 
+/** @typedef {import("./ChunkGroup")} ChunkGroup */
+
 class DependenciesBlock {
 	constructor() {
 		this.dependencies = [];
 		this.blocks = [];
 		this.variables = [];
+		/** @type {ChunkGroup=} */
+		this.chunkGroup = undefined;
 	}
 
 	addBlock(block) {

lib/GraphHelpers.js

@@ -1,28 +1,64 @@
-exports.connectChunkGroupAndChunk = (chunkGroup, chunk) => {
+/** @typedef {import("./Chunk")} Chunk */
+/** @typedef {import("./ChunkGroup")} ChunkGroup */
+/** @typedef {import("./Module")} Module */
+/** @typedef {import("./DependenciesBlock")} DependenciesBlock */
+
+/**
+ * @param {ChunkGroup} chunkGroup the ChunkGroup to connect
+ * @param {Chunk} chunk chunk to tie to ChunkGroup
+ * @returns {void}
+ */
+const connectChunkGroupAndChunk = (chunkGroup, chunk) => {
 	if (chunkGroup.pushChunk(chunk)) {
 		chunk.addGroup(chunkGroup);
 	}
 };
 
-exports.connectChunkGroupParentAndChild = (parent, child) => {
+/**
+ * @param {ChunkGroup} parent parent ChunkGroup to connect
+ * @param {ChunkGroup} child child ChunkGroup to connect
+ * @returns {void}
+ */
+const connectChunkGroupParentAndChild = (parent, child) => {
 	if (parent.addChild(child)) {
 		child.addParent(parent);
 	}
 };
 
-exports.connectChunkAndModule = (chunk, module) => {
+/**
+ * @param {Chunk} chunk Chunk to connect to Module
+ * @param {Module} module Module to connect to Chunk
+ * @returns {void}
+ */
+const connectChunkAndModule = (chunk, module) => {
 	if (module.addChunk(chunk)) {
 		chunk.addModule(module);
 	}
 };
 
-exports.disconnectChunkAndModule = (chunk, module) => {
+/**
+ * @param {Chunk} chunk Chunk being disconnected
+ * @param {Module} module Module being disconnected
+ * @returns {void}
+ */
+const disconnectChunkAndModule = (chunk, module) => {
 	chunk.removeModule(module);
 	module.removeChunk(chunk);
 };
 
-exports.connectDependenciesBlockAndChunkGroup = (depBlock, chunkGroup) => {
+/**
+ * @param {DependenciesBlock} depBlock DepBlock being tied to ChunkGroup
+ * @param {ChunkGroup} chunkGroup ChunkGroup being tied to DepBlock
+ * @returns {void}
+ */
+const connectDependenciesBlockAndChunkGroup = (depBlock, chunkGroup) => {
 	if (chunkGroup.addBlock(depBlock)) {
 		depBlock.chunkGroup = chunkGroup;
 	}
 };
+
+exports.connectChunkGroupAndChunk = connectChunkGroupAndChunk;
+exports.connectChunkGroupParentAndChild = connectChunkGroupParentAndChild;
+exports.connectChunkAndModule = connectChunkAndModule;
+exports.disconnectChunkAndModule = disconnectChunkAndModule;
+exports.connectDependenciesBlockAndChunkGroup = connectDependenciesBlockAndChunkGroup;