CR comments - remove TS syntax (one last type error)

mohsen1 · mohsen1 · commit 4859c926ad36 · 2018-06-19T15:32:15.000-07:00
diff --git a/lib/Chunk.js b/lib/Chunk.js
@@ -18,17 +18,8 @@ const ERR_CHUNK_INITIAL =
 /** @typedef {import("./ModuleReason.js")} ModuleReason */
 /** @typedef {import("webpack-sources").Source} Source */
 
-/** @typedef {(a: Module, b: Module) => -1|0|1} ModuleSortPredicate */
-/** @typedef {(m: Module) => boolean} ModuleFilterPredicate */
-/** @typedef {(c: Chunk) => boolean} ChunkFilterPredicate */
-
-/**
- *  @typedef {Object} Identifiable an object who contains an identifier function property
- *  @property {() => string} identifier the resource or unique identifier of something
- */
-
 /**
- *  @typedef {Object} WithId an object who has an id property
+ *  @typedef {Object} WithId an object who has an id property *
  *  @property {string | number} id the id of the object
  */
 
@@ -71,13 +62,13 @@ const getModulesIdent = set => {
 
 /**
  * @template T
- * @param {Set<T>} set the set to convert to array
+ * @param {SortableSet<T>} set the sortable set to convert to array
  * @returns {Array<T>} the array returned from Array.from(set)
  */
 const getArray = set => Array.from(set);
 
 /**
- * @param {Set<Module>} set the Set to get the count/size of
+ * @param {SortableSet<Module>} set the sortable Set to get the count/size of
  * @returns {number} the size of the modules
  */
 const getModulesSize = set => {
@@ -111,7 +102,7 @@ class Chunk {
 		this.entryModule = undefined;
 		/** @private @type {SortableSet<Module>} */
 		this._modules = new SortableSet(undefined, sortByIdentifier);
-		/** @private @type {SortableSet<ChunkGroup | WithId>} */
+		/** @private @type {SortableSet<ChunkGroup>} */
 		this._groups = new SortableSet(undefined, sortById);
 		/** @type {Source[]} */
 		this.files = [];
@@ -497,14 +488,14 @@ class Chunk {
 	}
 
 	/**
-	 * @param {ModuleSortPredicate=} sortByFn a predicate function used to sort modules
+	 * @param {function(Module, Module): -1|0|1=} sortByFn a predicate function used to sort modules
 	 * @returns {void}
 	 */
 	sortModules(sortByFn) {
 		this._modules.sortWith(sortByFn || sortById);
 	}
 
-	sortItems(sortChunks) {
+	sortItems() {
 		this.sortModules();
 	}
 
@@ -660,8 +651,8 @@ class Chunk {
 
 	/**
 	 *
-	 * @param {ModuleFilterPredicate} filterFn predicate function used to filter modules
-	 * @param {ChunkFilterPredicate} filterChunkFn predicate function used to filter chunks
+	 * @param {function(Module): boolean} filterFn predicate function used to filter modules
+	 * @param {function(Chunk): boolean} filterChunkFn predicate function used to filter chunks
 	 * @returns {boolean} return true if module exists in graph
 	 */
 	hasModuleInGraph(filterFn, filterChunkFn) {
diff --git a/lib/ChunkGroup.js b/lib/ChunkGroup.js
@@ -19,7 +19,7 @@ let debugId = 5000;
 
 /**
  * @template T
- * @param {Set<T>} set set to convert to array.
+ * @param {SortableSet<T>} set set to convert to array.
  * @returns {T[]} the array format of existing set
  */
 const getArray = set => Array.from(set);
diff --git a/lib/util/SortableSet.js b/lib/util/SortableSet.js
@@ -18,9 +18,9 @@ class SortableSet extends Set {
 		this._sortFn = defaultSort;
 		/** @private @type {(a: T, b: T) => number} | null} */
 		this._lastActiveSortFn = null;
-		/** @private @type {Map<Function, T> | undefined} */
+		/** @private @type {Map<Function, T[]> | undefined} */
 		this._cache = undefined;
-		/** @private @type {Map<Function, T> | undefined} */
+		/** @private @type {Map<Function, T[]|string|number> | undefined} */
 		this._cacheOrderIndependent = undefined;
 	}
 
@@ -79,9 +79,9 @@ class SortableSet extends Set {
 		this.sortWith(this._sortFn);
 	}
 
-	// eslint-disable-next-line valid-jsdoc
 	/**
-	 * @param {(instance: SortableSet<T>) => TODO} fn function to calculate value
+	 * Get data from cache
+	 * @param {function(SortableSet<T>): T[]} fn function to calculate value
 	 * @returns {TODO} returns result of fn(this), cached until set changes
 	 */
 	getFromCache(fn) {
@@ -99,7 +99,7 @@ class SortableSet extends Set {
 	}
 
 	/**
-	 * @param {Function} fn function to calculate value
+	 * @param {function(SortableSet<T>): string|number|T[]} fn function to calculate value
 	 * @returns {any} returns result of fn(this), cached until set changes
 	 */
 	getFromUnorderedCache(fn) {
