@aminzer/traverse-directory 1.0.0 → 1.1.0

package/README.md

@@ -29,7 +29,9 @@ await traverseDirectory('/path/to/directory', ({ isFile, relativePath }) => {
 `traverseDirectory` recursively iterates over the contents of a directory.
 
 ```typescript
-traverseDirectory(dirPath, onEachChild);
+import { directoryExists } from '@aminzer/traverse-directory';
+
+await traverseDirectory(dirPath, onEachChild);
 ```
 
 ##### Parameters
@@ -63,3 +65,24 @@ Instance properties:
 * `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/index.d.ts

@@ -1,2 +1,3 @@
 export { default as traverseDirectory } from './traverseDirectory';
+export { directoryExists } from './utils/fs';
 export { FsEntry } from './models';

package/dist/index.js

@@ -1,3 +1,4 @@
 export { default as traverseDirectory } from './traverseDirectory';
+export { directoryExists } from './utils/fs';
 export { FsEntry } from './models';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}

package/dist/traverseDirectory/traverseDirectory.js

@@ -1,7 +1,7 @@
-import { directoryExist } from '../utils/fs';
+import { directoryExists } from '../utils/fs';
 import traverseDirectoryRecursive from './traverseDirectoryRecursive';
 const traverseDirectory = async (dirPath, onEachChild) => {
-    if (!(await directoryExist(dirPath))) {
+    if (!(await directoryExists(dirPath))) {
         throw new Error(`Directory "${dirPath}" does not exist`);
     }
     await traverseDirectoryRecursive(dirPath, null, onEachChild);

package/dist/traverseDirectory/traverseDirectory.js.map

@@ -1 +1 @@
-{"version":3,"file":"traverseDirectory.js","sourceRoot":"","sources":["../../src/traverseDirectory/traverseDirectory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,0BAA0B,MAAM,8BAA8B,CAAC;AAGtE,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAe,EAAE,WAAwB,EAAiB,EAAE;IAC3F,IAAI,CAAC,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,cAAc,OAAO,kBAAkB,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,0BAA0B,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"traverseDirectory.js","sourceRoot":"","sources":["../../src/traverseDirectory/traverseDirectory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,0BAA0B,MAAM,8BAA8B,CAAC;AAGtE,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAe,EAAE,WAAwB,EAAiB,EAAE;IAC3F,IAAI,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,cAAc,OAAO,kBAAkB,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,0BAA0B,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/utils/fs/__tests__/{directoryExist.test.js → directoryExists.test.js}

@@ -1,25 +1,25 @@
 import assert from 'node:assert';
 import { join } from 'node:path';
 import { describe, it } from 'node:test';
-import directoryExist from '../directoryExist';
-describe('utils > fs > directoryExist', () => {
+import directoryExists from '../directoryExists';
+describe('utils > fs > directoryExists', () => {
     describe('when path does not exist', () => {
         const invalidPath = join(import.meta.dirname, 'invalid/path');
         it('returns false', async () => {
-            assert.strictEqual(await directoryExist(invalidPath), false);
+            assert.strictEqual(await directoryExists(invalidPath), false);
         });
     });
     describe('when path corresponds to file', () => {
         const filePath = import.meta.filename;
         it('returns false', async () => {
-            assert.strictEqual(await directoryExist(filePath), false);
+            assert.strictEqual(await directoryExists(filePath), false);
         });
     });
     describe('when path corresponds to directory', () => {
         const dirPath = import.meta.dirname;
         it('returns true', async () => {
-            assert.strictEqual(await directoryExist(dirPath), true);
+            assert.strictEqual(await directoryExists(dirPath), true);
         });
     });
 });
-//# sourceMappingURL=directoryExist.test.js.map
+//# sourceMappingURL=directoryExists.test.js.map

package/dist/utils/fs/__tests__/directoryExists.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directoryExists.test.js","sourceRoot":"","sources":["../../../../src/utils/fs/__tests__/directoryExists.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,eAAe,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAE9D,EAAE,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;QAEtC,EAAE,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QAEpC,EAAE,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC5B,MAAM,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/utils/fs/directoryExists.d.ts

@@ -0,0 +1,2 @@
+declare const directoryExists: (path: string) => Promise<boolean>;
+export default directoryExists;

package/dist/utils/fs/{directoryExist.js → directoryExists.js}

@@ -1,5 +1,5 @@
 import { stat } from 'node:fs/promises';
-const directoryExist = async (path) => {
+const directoryExists = async (path) => {
     try {
         const stats = await stat(path);
         return stats.isDirectory();
@@ -8,5 +8,5 @@ const directoryExist = async (path) => {
         return false;
     }
 };
-export default directoryExist;
-//# sourceMappingURL=directoryExist.js.map
+export default directoryExists;
+//# sourceMappingURL=directoryExists.js.map

package/dist/utils/fs/directoryExists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directoryExists.js","sourceRoot":"","sources":["../../../src/utils/fs/directoryExists.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IAC/D,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/dist/utils/fs/index.d.ts

@@ -1 +1 @@
-export { default as directoryExist } from './directoryExist';
+export { default as directoryExists } from './directoryExists';

package/dist/utils/fs/index.js

@@ -1,2 +1,2 @@
-export { default as directoryExist } from './directoryExist';
+export { default as directoryExists } from './directoryExists';
 //# sourceMappingURL=index.js.map

package/dist/utils/fs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/fs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/fs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aminzer/traverse-directory",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Utility for directory child entries recursive iteration",
   "publishConfig": {
     "access": "public"

package/dist/utils/fs/__tests__/directoryExist.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"directoryExist.test.js","sourceRoot":"","sources":["../../../../src/utils/fs/__tests__/directoryExist.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAE/C,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAE9D,EAAE,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,CAAC,WAAW,CAAC,MAAM,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;QAEtC,EAAE,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,CAAC,WAAW,CAAC,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QAEpC,EAAE,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC5B,MAAM,CAAC,WAAW,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/utils/fs/directoryExist.d.ts

@@ -1,2 +0,0 @@
-declare const directoryExist: (path: string) => Promise<boolean>;
-export default directoryExist;

package/dist/utils/fs/directoryExist.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"directoryExist.js","sourceRoot":"","sources":["../../../src/utils/fs/directoryExist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,MAAM,cAAc,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IAC9D,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}