Merge pull request webpack#7119 from webpack/feature/types-entrypoint

TheLarkInn · web-flow · commit 6b0dd009a5f8 · 2018-05-02T15:51:21.000-05:00
types(entrypoint): add typeing support for Entrypoint
diff --git a/lib/Entrypoint.js b/lib/Entrypoint.js
@@ -6,20 +6,46 @@
 
 const ChunkGroup = require("./ChunkGroup");
 
+/** @typedef {import("./Chunk.js")} Chunk */
+
+/**
+ * Entrypoint serves as an encapsulation primitive for chunks that are
+ * a part of a single ChunkGroup. They represent all bundles that need to be loaded for a
+ * single instance of a page. Multi-page application architectures will typically yield multiple Entrypoint objects
+ * inside of the compilation, whereas a Single Page App may only contain one with many lazy-loaded chunks.
+ */
 class Entrypoint extends ChunkGroup {
+	/**
+	 * Creates an instance of Entrypoint.
+	 * @param {string} name the name of the entrypoint
+	 */
 	constructor(name) {
 		super(name);
+		/** @type {Chunk=} */
 		this.runtimeChunk = undefined;
 	}
 
+	/**
+	 * isInitial will always return true for Entrypoint ChunkGroup.
+	 * @return {true} returns true as all entrypoints are initial ChunkGroups
+	 */
 	isInitial() {
 		return true;
 	}
 
+	/**
+	 * Sets the runtimeChunk for an entrypoint.
+	 * @param {Chunk} chunk the chunk being set as the runtime chunk.
+	 * @return {void}
+	 */
 	setRuntimeChunk(chunk) {
 		this.runtimeChunk = chunk;
 	}
 
+	/**
+	 * Fetches the chunk reference containing the webpack bootstrap code
+	 * @return {Chunk} returns the runtime chunk or first chunk in `this.chunks`
+	 */
 	getRuntimeChunk() {
 		return this.runtimeChunk || this.chunks[0];
 	}
