Merge pull request webpack#7051 from webpack/feature/type-utils-identifier

sokra · web-flow · commit 0e73be3caf34 · 2018-04-23T15:11:19.000+02:00
refactor(types): add type comments for util/identifier
diff --git a/lib/util/identifier.js b/lib/util/identifier.js
@@ -1,12 +1,33 @@
 "use strict";
 const path = require("path");
 
+/**
+ * @typedef {Object} MakeRelativePathsCache
+ * @property {Map<string, Map<string, string>>=} relativePaths
+ */
+
+/**
+ *
+ * @param {string} maybeAbsolutePath path to check
+ * @return {boolean} returns true if path is "Absolute Path"-like
+ */
 const looksLikeAbsolutePath = maybeAbsolutePath => {
 	return /^(?:[a-z]:\\|\/)/i.test(maybeAbsolutePath);
 };
 
+/**
+ *
+ * @param {string} p path to normalize
+ * @return {string} normalized version of path
+ */
 const normalizePathSeparator = p => p.replace(/\\/g, "/");
 
+/**
+ *
+ * @param {string} context context for relative path
+ * @param {string} identifier identifier for path
+ * @return {string} a converted relative path
+ */
 const _makePathsRelative = (context, identifier) => {
 	return identifier
 		.split(/([|! ])/)
@@ -19,6 +40,13 @@ const _makePathsRelative = (context, identifier) => {
 		.join("");
 };
 
+/**
+ *
+ * @param {string} context context used to create relative path
+ * @param {string} identifier identifier used to create relative path
+ * @param {MakeRelativePathsCache=} cache the cache object being set
+ * @return {string} the returned relative path
+ */
 exports.makePathsRelative = (context, identifier, cache) => {
 	if (!cache) return _makePathsRelative(context, identifier);
 
