Merge pull request webpack#7133 from webpack/feature/type-set-helpers

sokra · web-flow · commit d5eeda7f8040 · 2018-05-01T14:32:18.000+02:00
chore(types): add type support for SetHelpers
diff --git a/lib/util/SetHelpers.js b/lib/util/SetHelpers.js
@@ -1,6 +1,11 @@
 "use strict";
 
-exports.intersect = sets => {
+/**
+ * intersect creates Set containing the intersection of elements between all sets
+ * @param {Set[]} sets an array of sets being checked for shared elements
+ * @returns {Set} returns a new Set containing the intersecting items
+ */
+function intersect(sets) {
 	if (sets.length === 0) return new Set();
 	if (sets.length === 1) return new Set(sets[0]);
 	let minSize = Infinity;
@@ -23,12 +28,21 @@ exports.intersect = sets => {
 		}
 	}
 	return current;
-};
+}
 
-exports.isSubset = (bigSet, smallSet) => {
+/**
+ * Checks if a set is the subset of another set
+ * @param {Set} bigSet a Set which contains the original elements to compare against
+ * @param {Set} smallSet the set whos elements might be contained inside of bigSet
+ * @returns {boolean} returns true if smallSet contains all elements inside of the bigSet
+ */
+function isSubset(bigSet, smallSet) {
 	if (bigSet.size < smallSet.size) return false;
 	for (const item of smallSet) {
 		if (!bigSet.has(item)) return false;
 	}
 	return true;
-};
+}
+
+exports.intersect = intersect;
+exports.isSubset = isSubset;
