Add jsdocs

advplyr · Oct 23, 2023 · 9a477a9 · 9a477a9
1 parent 976ae50
commit 9a477a9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/server/utils/fileUtils.js b/server/utils/fileUtils.js
@@ -19,6 +19,13 @@ const filePathToPOSIX = (path) => {
 }
 module.exports.filePathToPOSIX = filePathToPOSIX
 
+/**
+ * Check path is a child of or equal to another path
+ * 
+ * @param {string} parentPath 
+ * @param {string} childPath 
+ * @returns {boolean}
+ */
 function isSameOrSubPath(parentPath, childPath) {
   parentPath = filePathToPOSIX(parentPath)
   childPath = filePathToPOSIX(childPath)