@aminzer/traverse-directory 1.2.6 → 1.2.8

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Aliaksei Minzer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2025 Aliaksei Minzer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,88 +1,88 @@
-### Overview
-
-[NodeJS](https://nodejs.org) utility for recursively iterating over directory contents.
-
-It allows to traverse through all subdirectories and files within a specified directory.
-
-### Installation
-
-```bash
-npm i @aminzer/traverse-directory
-```
-
-### Usage examples
-
-```typescript
-import { traverseDirectory } from '@aminzer/traverse-directory';
-
-await traverseDirectory('/path/to/directory', ({ isFile, relativePath }) => {
-  console.log(`${isFile ? 'File' : 'Directory'} ${relativePath} was found`);
-});
-```
-
-### API
-
-**traverseDirectory**
-
-##### Overview
-
-`traverseDirectory` recursively iterates over the contents of a directory.
-
-```typescript
-import { directoryExists } from '@aminzer/traverse-directory';
-
-await traverseDirectory(dirPath, onEachChild);
-```
-
-##### Parameters
-
-* `dirPath` (`string`, required) - path to the directory whose contents should be iterated.
-* `onEachChild` (`function`, required) - callback invoked for each child file and directory.
-
-`onEachChild` callback accepts following arguments:
-* `fsEntry` (`FsEntry`) - currently iterated child file or directory.
-* `additionalArgs` (`object`, optional) - additional callback arguments:
-    * `skipEntryChildrenIteration` (`function`) - call this function within `onEachChild` to skip iterating the children of the current entry.
-
-##### Return value
-
-`Promise` that resolves when the directory traversal is complete.
-
-**FsEntry**
-
-##### Overview
-
-`FsEntry` - class representing File System Entry (file or directory).
-
-```typescript
-import { FsEntry } from '@aminzer/traverse-directory';
-```
-
-Instance properties:
-* `name` (`string`) - name of entry.
-* `absolutePath` (`string`) - absolute path to entry.
-* `relativePath` (`string`) - relative path to entry. It's relative to the directory passed to `traverseDirectory`.
-* `size` (`number`) - size of file in bytes, `0` for directories.
-* `isFile` (`boolean`) - `true` if entry is file.
-* `isDirectory` (`boolean`) - `true` if entry is directory.
-
-
-**directoryExists**
-
-##### Overview
-
-`directoryExists` is an async function that checks if a given path exists and corresponds to a directory.
-
-```typescript
-import { directoryExists } from '@aminzer/traverse-directory';
-
-const exists = await directoryExists('/path/to/directory');
-```
-
-##### Parameters
-
-* `dirPath` (`string`, required) - path to the directory to check.
-
-##### Return value
-
-`Promise<boolean>` that resolves to `true` if the directory exists, or `false` otherwise.
+### Overview
+
+[NodeJS](https://nodejs.org) utility for recursively iterating over directory contents.
+
+It allows to traverse through all subdirectories and files within a specified directory.
+
+### Installation
+
+```bash
+npm i @aminzer/traverse-directory
+```
+
+### Usage examples
+
+```typescript
+import { traverseDirectory } from '@aminzer/traverse-directory';
+
+await traverseDirectory('/path/to/directory', ({ isFile, relativePath }) => {
+  console.log(`${isFile ? 'File' : 'Directory'} ${relativePath} was found`);
+});
+```
+
+### API
+
+**traverseDirectory**
+
+##### Overview
+
+`traverseDirectory` recursively iterates over the contents of a directory.
+
+```typescript
+import { directoryExists } from '@aminzer/traverse-directory';
+
+await traverseDirectory(dirPath, onEachChild);
+```
+
+##### Parameters
+
+* `dirPath` (`string`, required) - path to the directory whose contents should be iterated.
+* `onEachChild` (`function`, required) - callback invoked for each child file and directory.
+
+`onEachChild` callback accepts following arguments:
+* `fsEntry` (`FsEntry`) - currently iterated child file or directory.
+* `additionalArgs` (`object`, optional) - additional callback arguments:
+    * `skipEntryChildrenIteration` (`function`) - call this function within `onEachChild` to skip iterating the children of the current entry.
+
+##### Return value
+
+`Promise` that resolves when the directory traversal is complete.
+
+**FsEntry**
+
+##### Overview
+
+`FsEntry` - class representing File System Entry (file or directory).
+
+```typescript
+import { FsEntry } from '@aminzer/traverse-directory';
+```
+
+Instance properties:
+* `name` (`string`) - name of entry.
+* `absolutePath` (`string`) - absolute path to entry.
+* `relativePath` (`string`) - relative path to entry. It's relative to the directory passed to `traverseDirectory`.
+* `size` (`number`) - size of file in bytes, `0` for directories.
+* `isFile` (`boolean`) - `true` if entry is file.
+* `isDirectory` (`boolean`) - `true` if entry is directory.
+
+
+**directoryExists**
+
+##### Overview
+
+`directoryExists` is an async function that checks if a given path exists and corresponds to a directory.
+
+```typescript
+import { directoryExists } from '@aminzer/traverse-directory';
+
+const exists = await directoryExists('/path/to/directory');
+```
+
+##### Parameters
+
+* `dirPath` (`string`, required) - path to the directory to check.
+
+##### Return value
+
+`Promise<boolean>` that resolves to `true` if the directory exists, or `false` otherwise.

package/dist/traverseDirectory/traverseDirectoryRecursive.js

@@ -2,30 +2,37 @@ import { join } from 'node:path';
 import { stat, readdir } from 'node:fs/promises';
 import { FsEntry } from '../models/index.js';
 import { iterateInSeries } from '../utils/iteration/index.js';
+const STAT_CONCURRENCY = 64;
 const traverseDirectoryRecursive = async (absoluteDirPath, relativeDirPath, onEachChild) => {
-    const entries = await readdir(absoluteDirPath);
-    await iterateInSeries(entries, async (name) => {
-        const absolutePath = join(absoluteDirPath, name);
-        const relativePath = relativeDirPath ? join(relativeDirPath, name) : name;
-        const stats = await stat(absolutePath);
-        const isFile = stats.isFile();
-        const size = isFile ? stats.size : 0;
-        const fsEntry = new FsEntry({
-            name,
-            absolutePath,
-            relativePath,
-            isFile,
-            size,
+    const entries = await readdir(absoluteDirPath, { withFileTypes: true });
+    for (let batchStart = 0; batchStart < entries.length; batchStart += STAT_CONCURRENCY) {
+        const batchEntries = entries.slice(batchStart, batchStart + STAT_CONCURRENCY);
+        const batchStats = await Promise.all(batchEntries.map((entry) => {
+            return entry.isDirectory() ? null : stat(join(absoluteDirPath, entry.name));
+        }));
+        await iterateInSeries(batchEntries, async ({ name }, index) => {
+            const absolutePath = join(absoluteDirPath, name);
+            const relativePath = relativeDirPath ? join(relativeDirPath, name) : name;
+            const stats = batchStats[index];
+            const isFile = stats !== null && stats.isFile();
+            const size = isFile ? stats.size : 0;
+            const fsEntry = new FsEntry({
+                name,
+                absolutePath,
+                relativePath,
+                isFile,
+                size,
+            });
+            let iterateEntry = fsEntry.isDirectory;
+            const skipEntryChildrenIteration = () => {
+                iterateEntry = false;
+            };
+            await onEachChild(fsEntry, { skipEntryChildrenIteration });
+            if (iterateEntry) {
+                await traverseDirectoryRecursive(absolutePath, relativePath, onEachChild);
+            }
         });
-        let iterateEntry = fsEntry.isDirectory;
-        const skipEntryChildrenIteration = () => {
-            iterateEntry = false;
-        };
-        await onEachChild(fsEntry, { skipEntryChildrenIteration });
-        if (iterateEntry) {
-            await traverseDirectoryRecursive(absolutePath, relativePath, onEachChild);
-        }
-    });
+    }
 };
 export default traverseDirectoryRecursive;
 //# sourceMappingURL=traverseDirectoryRecursive.js.map

package/dist/traverseDirectory/traverseDirectoryRecursive.js.map

@@ -1 +1 @@
-{"version":3,"file":"traverseDirectoryRecursive.js","sourceRoot":"","sources":["../../src/traverseDirectory/traverseDirectoryRecursive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,MAAM,0BAA0B,GAAG,KAAK,EACtC,eAAuB,EACvB,eAA8B,EAC9B,WAAwB,EACT,EAAE;IACjB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C,MAAM,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE;QACpD,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACjD,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE1E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAErC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;YAC1B,IAAI;YACJ,YAAY;YACZ,YAAY;YACZ,MAAM;YACN,IAAI;SACL,CAAC,CAAC;QAEH,IAAI,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;QAEvC,MAAM,0BAA0B,GAAG,GAAG,EAAE;YACtC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC,CAAC;QAEF,MAAM,WAAW,CAAC,OAAO,EAAE,EAAE,0BAA0B,EAAE,CAAC,CAAC;QAE3D,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,0BAA0B,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,0BAA0B,CAAC"}
+{"version":3,"file":"traverseDirectoryRecursive.js","sourceRoot":"","sources":["../../src/traverseDirectory/traverseDirectoryRecursive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B,MAAM,0BAA0B,GAAG,KAAK,EACtC,eAAuB,EACvB,eAA8B,EAC9B,WAAwB,EACT,EAAE;IACjB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,eAAe,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAExE,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI,gBAAgB,EAAE,CAAC;QACrF,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAC,CAAC;QAE9E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAa,EAAyB,EAAE;YACxD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,eAAe,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,IAAI,EAAU,EAAE,KAAa,EAAE,EAAE;YAC5E,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACjD,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAE1E,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAErC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;gBAC1B,IAAI;gBACJ,YAAY;gBACZ,YAAY;gBACZ,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YAEH,IAAI,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;YAEvC,MAAM,0BAA0B,GAAG,GAAG,EAAE;gBACtC,YAAY,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC;YAEF,MAAM,WAAW,CAAC,OAAO,EAAE,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAE3D,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,0BAA0B,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,0BAA0B,CAAC"}

package/dist/utils/iteration/iterateInSeries.d.ts

@@ -1,2 +1,2 @@
-declare const iterateInSeries: <T>(array: T[], callback: (element: T, index?: number) => void | Promise<void>) => Promise<void>;
+declare const iterateInSeries: <T>(array: T[], callback: (element: T, index: number) => void | Promise<void>) => Promise<void>;
 export default iterateInSeries;

package/dist/utils/iteration/iterateInSeries.js.map

@@ -1 +1 @@
-{"version":3,"file":"iterateInSeries.js","sourceRoot":"","sources":["../../../src/utils/iteration/iterateInSeries.ts"],"names":[],"mappings":"AAAA,MAAM,eAAe,GAAG,KAAK,EAC3B,KAAU,EACV,QAA8D,EAC/C,EAAE;IACjB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}
+{"version":3,"file":"iterateInSeries.js","sourceRoot":"","sources":["../../../src/utils/iteration/iterateInSeries.ts"],"names":[],"mappings":"AAAA,MAAM,eAAe,GAAG,KAAK,EAC3B,KAAU,EACV,QAA6D,EAC9C,EAAE;IACjB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/package.json

@@ -1,59 +1,59 @@
-{
-  "name": "@aminzer/traverse-directory",
-  "version": "1.2.6",
-  "description": "Utility for directory child entries recursive iteration",
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module",
-  "keywords": [
-    "traverse",
-    "directory",
-    "fs",
-    "filesystem",
-    "file",
-    "folder",
-    "iterate",
-    "recursion",
-    "recursive"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/aminzer/traverse-directory.git"
-  },
-  "license": "MIT",
-  "author": "aminzer",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "build:watch": "npm run build -- --watch",
-    "clean": "rimraf dist",
-    "codestyle": "run-p lint typescript:check",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "npm run lint -- --fix",
-    "prepare": "npm run rebuild",
-    "rebuild": "run-s clean build",
-    "test": "tsx --test src/**/*.test.ts",
-    "typescript:check": "tsc --project tsconfig.json --noEmit"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.36.0",
-    "@types/node": "^24.5.2",
-    "eslint": "^9.36.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.4",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "tsx": "^4.20.6",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.44.1"
-  },
-  "engines": {
-    "node": ">=22.0.0"
-  }
-}
+{
+  "name": "@aminzer/traverse-directory",
+  "version": "1.2.8",
+  "description": "Utility for directory child entries recursive iteration",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "keywords": [
+    "traverse",
+    "directory",
+    "fs",
+    "filesystem",
+    "file",
+    "folder",
+    "iterate",
+    "recursion",
+    "recursive"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aminzer/traverse-directory.git"
+  },
+  "license": "MIT",
+  "author": "aminzer",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build:watch": "npm run build -- --watch",
+    "clean": "rimraf dist",
+    "codestyle": "run-p lint typescript:check",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "npm run lint -- --fix",
+    "prepare": "npm run rebuild",
+    "rebuild": "run-s clean build",
+    "test": "tsx --test src/**/*.test.ts",
+    "typescript:check": "tsc --project tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.36.0",
+    "@types/node": "^24.5.2",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.44.1"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}