Merge pull request webpack#7354 from mohsen1/type-compare-locations

sokra · web-flow · commit d2c65132890a · 2018-05-20T21:57:15.000+02:00
Type compare locations
diff --git a/lib/compareLocations.js b/lib/compareLocations.js
@@ -3,6 +3,26 @@
 	Author Tobias Koppers @sokra
 */
 "use strict";
+
+/**
+ * @typedef {Object} LineAndColumn
+ * @property {number=} line
+ * @property {number=} column
+ */
+
+/**
+ * @typedef {Object} NodeLocation
+ * @property {LineAndColumn=} start
+ * @property {LineAndColumn=} end
+ * @property {number=} index
+ */
+
+/**
+ * Compare two locations
+ * @param {string|NodeLocation} a A location node
+ * @param {string|NodeLocation} b A location node
+ * @returns {-1|0|1} sorting comparator value
+ */
 module.exports = (a, b) => {
 	if (typeof a === "string") {
 		if (typeof b === "string") {
