@file-services/overlay - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

cjs/overlay-fs.js

@@ -90,9 +90,9 @@ "use strict";
         },
-        readdirSync(path) {
+        readdirSync: ((path, ...args) => {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = upperFs.readdirSync(resolvedUpperPath);
+                    const resInUpper = upperFs.readdirSync(resolvedUpperPath, ...args);
                     try {
-                        return [...lowerFs.readdirSync(resolvedLowerPath), ...resInUpper];
+                        return [...lowerFs.readdirSync(resolvedLowerPath, ...args), ...resInUpper];
                     }
@@ -107,4 +107,4 @@ catch (_a) {
             }
-            return lowerFs.readdirSync(resolvedLowerPath);
-        }
+            return lowerFs.readdirSync(resolvedLowerPath, ...args);
+        })
     };
@@ -121,7 +121,7 @@ const basePromiseActions = {
         },
-        readFile: async function readFile(path, ...restArgs) {
+        readFile: async function readFile(path, ...args) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    return await upperPromises.readFile(resolvedUpperPath, ...restArgs);
+                    return await upperPromises.readFile(resolvedUpperPath, ...args);
                 }
@@ -132,3 +132,3 @@ catch (_a) {
             }
-            return lowerPromises.readFile(resolvedLowerPath, ...restArgs);
+            return lowerPromises.readFile(resolvedLowerPath, ...args);
         },
@@ -183,9 +183,9 @@ async stat(path) {
         },
-        async readdir(path) {
+        readdir: async function readdir(path, ...args) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = await upperPromises.readdir(resolvedUpperPath);
+                    const resInUpper = await upperPromises.readdir(resolvedUpperPath, ...args);
                     try {
-                        return [...(await lowerPromises.readdir(resolvedLowerPath)), ...resInUpper];
+                        return [...(await lowerPromises.readdir(resolvedLowerPath, ...args)), ...resInUpper];
                     }
@@ -201,3 +201,3 @@ catch (_a) {
             }
-            return lowerPromises.readdir(resolvedLowerPath);
+            return lowerPromises.readdir(resolvedLowerPath, ...args);
         }
@@ -309,11 +309,18 @@ };
         },
-        readdir(path, callback) {
+        readdir(path, options, callback) {
+            if (typeof options === 'function') {
+                callback = options;
+                options = undefined;
+            }
+            else if (typeof callback !== 'function') {
+                throw new Error(`callback is not a function.`);
+            }
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
-                upperFs.readdir(resolvedUpperPath, (upperError, upperItems) => {
+                upperFs.readdir(resolvedUpperPath, options, (upperError, upperItems) => {
                     if (upperError) {
-                        lowerFs.readdir(resolvedLowerPath, callback);
+                        lowerFs.readdir(resolvedLowerPath, options, callback);
                     }
                     else {
-                        lowerFs.readdir(resolvedLowerPath, (lowerError, lowerItems) => {
+                        lowerFs.readdir(resolvedLowerPath, options, (lowerError, lowerItems) => {
                             if (lowerError) {
@@ -323,3 +330,6 @@ callback(upperError, upperItems);
                             else {
-                                callback(upperError, [...lowerItems, ...upperItems]);
+                                callback(upperError, [
+                                    ...lowerItems,
+                                    ...upperItems
+                                ]);
                             }
@@ -331,3 +341,3 @@ });
             else {
-                lowerFs.readdir(resolvedLowerPath, callback);
+                lowerFs.readdir(resolvedLowerPath, options, callback);
             }
@@ -334,0 +344,0 @@ }

esm/overlay-fs.js

@@ -88,9 +88,9 @@ import { createFileSystem } from '@file-services/utils';
         },
-        readdirSync(path) {
+        readdirSync: ((path, ...args) => {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = upperFs.readdirSync(resolvedUpperPath);
+                    const resInUpper = upperFs.readdirSync(resolvedUpperPath, ...args);
                     try {
-                        return [...lowerFs.readdirSync(resolvedLowerPath), ...resInUpper];
+                        return [...lowerFs.readdirSync(resolvedLowerPath, ...args), ...resInUpper];
                     }
@@ -105,4 +105,4 @@ catch (_a) {
             }
-            return lowerFs.readdirSync(resolvedLowerPath);
-        }
+            return lowerFs.readdirSync(resolvedLowerPath, ...args);
+        })
     };
@@ -119,7 +119,7 @@ const basePromiseActions = {
         },
-        readFile: async function readFile(path, ...restArgs) {
+        readFile: async function readFile(path, ...args) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    return await upperPromises.readFile(resolvedUpperPath, ...restArgs);
+                    return await upperPromises.readFile(resolvedUpperPath, ...args);
                 }
@@ -130,3 +130,3 @@ catch (_a) {
             }
-            return lowerPromises.readFile(resolvedLowerPath, ...restArgs);
+            return lowerPromises.readFile(resolvedLowerPath, ...args);
         },
@@ -181,9 +181,9 @@ async stat(path) {
         },
-        async readdir(path) {
+        readdir: async function readdir(path, ...args) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = await upperPromises.readdir(resolvedUpperPath);
+                    const resInUpper = await upperPromises.readdir(resolvedUpperPath, ...args);
                     try {
-                        return [...(await lowerPromises.readdir(resolvedLowerPath)), ...resInUpper];
+                        return [...(await lowerPromises.readdir(resolvedLowerPath, ...args)), ...resInUpper];
                     }
@@ -199,3 +199,3 @@ catch (_a) {
             }
-            return lowerPromises.readdir(resolvedLowerPath);
+            return lowerPromises.readdir(resolvedLowerPath, ...args);
         }
@@ -307,11 +307,18 @@ };
         },
-        readdir(path, callback) {
+        readdir(path, options, callback) {
+            if (typeof options === 'function') {
+                callback = options;
+                options = undefined;
+            }
+            else if (typeof callback !== 'function') {
+                throw new Error(`callback is not a function.`);
+            }
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
-                upperFs.readdir(resolvedUpperPath, (upperError, upperItems) => {
+                upperFs.readdir(resolvedUpperPath, options, (upperError, upperItems) => {
                     if (upperError) {
-                        lowerFs.readdir(resolvedLowerPath, callback);
+                        lowerFs.readdir(resolvedLowerPath, options, callback);
                     }
                     else {
-                        lowerFs.readdir(resolvedLowerPath, (lowerError, lowerItems) => {
+                        lowerFs.readdir(resolvedLowerPath, options, (lowerError, lowerItems) => {
                             if (lowerError) {
@@ -321,3 +328,6 @@ callback(upperError, upperItems);
                             else {
-                                callback(upperError, [...lowerItems, ...upperItems]);
+                                callback(upperError, [
+                                    ...lowerItems,
+                                    ...upperItems
+                                ]);
                             }
@@ -329,3 +339,3 @@ });
             else {
-                lowerFs.readdir(resolvedLowerPath, callback);
+                lowerFs.readdir(resolvedLowerPath, options, callback);
             }
@@ -332,0 +342,0 @@ }

package.json

 {
   "name": "@file-services/overlay",
   "description": "Overlay files and directories from one file system on top of another.",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "main": "cjs/index.js",
@@ -17,4 +17,4 @@ "module": "esm/index.js",
   "dependencies": {
-    "@file-services/types": "^1.0.3",
-    "@file-services/utils": "^1.0.3"
+    "@file-services/types": "^1.0.4",
+    "@file-services/utils": "^1.0.4"
   },
@@ -34,3 +34,3 @@ "files": [
   "sideEffects": false,
-  "gitHead": "68be952fd0bcc14ebc5e2ad184603a4db7330941"
+  "gitHead": "5324bae9c23054284cb0727692dae2b6a1cb1560"
 }

src/overlay-fs.ts

@@ -7,3 +7,4 @@ import {
     CallbackFn,
-    ReadFileOptions
+    ReadFileOptions,
+    IDirectoryEntry
 } from '@file-services/types';
@@ -99,9 +100,9 @@ import { createFileSystem } from '@file-services/utils';
         },
-        readdirSync(path) {
+        readdirSync: ((path: string, ...args: [{ withFileTypes: false }]) => {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = upperFs.readdirSync(resolvedUpperPath);
+                    const resInUpper = upperFs.readdirSync(resolvedUpperPath, ...args);
                     try {
-                        return [...lowerFs.readdirSync(resolvedLowerPath), ...resInUpper];
+                        return [...lowerFs.readdirSync(resolvedLowerPath, ...args), ...resInUpper];
                     } catch {
@@ -114,4 +115,4 @@ return resInUpper;
             }
-            return lowerFs.readdirSync(resolvedLowerPath);
-        }
+            return lowerFs.readdirSync(resolvedLowerPath, ...args);
+        }) as IBaseFileSystemSyncActions['readdirSync']
     };
@@ -130,7 +131,7 @@
         },
-        readFile: async function readFile(path: string, ...restArgs: [ReadFileOptions]) {
+        readFile: async function readFile(path: string, ...args: [ReadFileOptions]) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    return await upperPromises.readFile(resolvedUpperPath, ...restArgs);
+                    return await upperPromises.readFile(resolvedUpperPath, ...args);
                 } catch {
@@ -140,3 +141,3 @@ /**/
             }
-            return lowerPromises.readFile(resolvedLowerPath, ...restArgs);
+            return lowerPromises.readFile(resolvedLowerPath, ...args);
         } as IBaseFileSystemPromiseActions['readFile'],
@@ -187,9 +188,9 @@ async stat(path) {
         },
-        async readdir(path) {
+        readdir: async function readdir(path: string, ...args: [{ withFileTypes: false }]) {
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
                 try {
-                    const resInUpper = await upperPromises.readdir(resolvedUpperPath);
+                    const resInUpper = await upperPromises.readdir(resolvedUpperPath, ...args);
                     try {
-                        return [...(await lowerPromises.readdir(resolvedLowerPath)), ...resInUpper];
+                        return [...(await lowerPromises.readdir(resolvedLowerPath, ...args)), ...resInUpper];
                     } catch {
@@ -203,4 +204,4 @@ /**/
             }
-            return lowerPromises.readdir(resolvedLowerPath);
-        }
+            return lowerPromises.readdir(resolvedLowerPath, ...args);
+        } as IBaseFileSystemPromiseActions['readdir']
     };
@@ -303,20 +304,45 @@
         },
-        readdir(path, callback) {
+        readdir(
+            path: string,
+            options: string | { withFileTypes?: boolean } | undefined | null | CallbackFn<string[]>,
+            callback?: CallbackFn<string[]> | CallbackFn<IDirectoryEntry[]>
+        ) {
+            if (typeof options === 'function') {
+                callback = options;
+                options = undefined;
+            } else if (typeof callback !== 'function') {
+                throw new Error(`callback is not a function.`);
+            }
             const { resolvedLowerPath, resolvedUpperPath } = resolvePaths(path);
             if (resolvedUpperPath !== undefined) {
-                upperFs.readdir(resolvedUpperPath, (upperError, upperItems) => {
+                upperFs.readdir(resolvedUpperPath, options as { withFileTypes: true }, (upperError, upperItems) => {
                     if (upperError) {
-                        lowerFs.readdir(resolvedLowerPath, callback);
+                        lowerFs.readdir(
+                            resolvedLowerPath,
+                            options as { withFileTypes: true },
+                            callback as CallbackFn<IDirectoryEntry[]>
+                        );
                     } else {
-                        lowerFs.readdir(resolvedLowerPath, (lowerError, lowerItems) => {
-                            if (lowerError) {
-                                callback(upperError, upperItems);
-                            } else {
-                                callback(upperError, [...lowerItems, ...upperItems]);
+                        lowerFs.readdir(
+                            resolvedLowerPath,
+                            options as { withFileTypes: true },
+                            (lowerError, lowerItems) => {
+                                if (lowerError) {
+                                    (callback as CallbackFn<IDirectoryEntry[]>)(upperError, upperItems);
+                                } else {
+                                    (callback as CallbackFn<IDirectoryEntry[]>)(upperError, [
+                                        ...lowerItems,
+                                        ...upperItems
+                                    ]);
+                                }
                             }
-                        });
+                        );
                     }
                 });
             } else {
-                lowerFs.readdir(resolvedLowerPath, callback);
+                lowerFs.readdir(
+                    resolvedLowerPath,
+                    options as { withFileTypes: true },
+                    callback as CallbackFn<IDirectoryEntry[]>
+                );
             }
@@ -323,0 +349,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

65730

increased by5.26%

Lines of code

1031

increased by4.67%

Dependency changes

• Updated@file-services/types@^1.0.4

• Updated@file-services/utils@^1.0.4