@jeniex/utils 1.0.13 → 1.0.15

package/node/index.cjs

@@ -92,6 +92,28 @@ async function listFolders({ folderPath, getFullPath }) {
     return folders;
 }
 
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
+function listFoldersSync({ folderPath, getFullPath }) {
+    if (fs.existsSync(folderPath) === false) {
+        throw new Error('The provided folder path does not exist!');
+    }
+    const entries = fs.readdirSync(folderPath, {
+        withFileTypes: true,
+    });
+    const folders = entries
+        .filter((entry) => entry.isDirectory() === true)
+        .map((folderEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, folderEntry.name);
+        }
+        return folderEntry.name;
+    });
+    return folders;
+}
+
 async function removeFiles({ folderPath, filter }) {
     const nestedFilePathPattern = `${path.resolve('./')}\\`;
     if (!folderPath.startsWith(nestedFilePathPattern)) {
@@ -112,6 +134,7 @@ exports.isString = isString;
 exports.isTruthy = isTruthy;
 exports.listFiles = listFiles;
 exports.listFolders = listFolders;
+exports.listFoldersSync = listFoldersSync;
 exports.noop = noop;
 exports.removeFiles = removeFiles;
 exports.sleep = sleep;

package/node/index.d.ts

@@ -46,6 +46,12 @@ declare function listFiles({ folderPath, getFullPath, filter }: ListFilesOpt): P
  */
 declare function listFolders({ folderPath, getFullPath }: ListFoldersOpt): Promise<string[]>;
 
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
+declare function listFoldersSync({ folderPath, getFullPath }: ListFoldersOpt): string[];
+
 declare function removeFiles({ folderPath, filter }: RemoveFilesOpt): Promise<void>;
 
-export { Fn, Nullable, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, noop, removeFiles, sleep };
+export { Fn, Nullable, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, listFoldersSync, noop, removeFiles, sleep };

package/node/index.js

@@ -90,6 +90,28 @@ async function listFolders({ folderPath, getFullPath }) {
     return folders;
 }
 
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
+function listFoldersSync({ folderPath, getFullPath }) {
+    if (fs.existsSync(folderPath) === false) {
+        throw new Error('The provided folder path does not exist!');
+    }
+    const entries = fs.readdirSync(folderPath, {
+        withFileTypes: true,
+    });
+    const folders = entries
+        .filter((entry) => entry.isDirectory() === true)
+        .map((folderEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, folderEntry.name);
+        }
+        return folderEntry.name;
+    });
+    return folders;
+}
+
 async function removeFiles({ folderPath, filter }) {
     const nestedFilePathPattern = `${path.resolve('./')}\\`;
     if (!folderPath.startsWith(nestedFilePathPattern)) {
@@ -101,4 +123,4 @@ async function removeFiles({ folderPath, filter }) {
     }
 }
 
-export { asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, noop, removeFiles, sleep };
+export { asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, listFoldersSync, noop, removeFiles, sleep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",