tiny-readdir 2.1.0 → 2.2.0

package/dist/index.js

@@ -1,12 +1,14 @@
 /* IMPORT */
 import fs from 'node:fs';
 import path from 'node:path';
+import { isFunction } from './utils.js';
 /* MAIN */
 const readdir = (rootPath, options) => {
     const followSymlinks = options?.followSymlinks ?? false;
     const maxDepth = options?.depth ?? Infinity;
     const maxPaths = options?.limit ?? Infinity;
-    const isIgnored = options?.ignore ?? (() => false);
+    const ignore = options?.ignore ?? (() => false);
+    const isIgnored = isFunction(ignore) ? ignore : (targetPath) => ignore.test(targetPath);
     const signal = options?.signal ?? { aborted: false };
     const directories = [];
     const files = [];

package/dist/types.d.ts

@@ -3,7 +3,7 @@ type Options = {
     depth?: number;
     limit?: number;
     followSymlinks?: boolean;
-    ignore?: (targetPath: string) => boolean;
+    ignore?: ((targetPath: string) => boolean) | RegExp;
     signal?: {
         aborted: boolean;
     };

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+declare const isFunction: (value: unknown) => value is Function;
+export { isFunction };

package/dist/utils.js

@@ -0,0 +1,6 @@
+/* MAIN */
+const isFunction = (value) => {
+    return (typeof value === 'function');
+};
+/* EXPORT */
+export { isFunction };

package/package.json

@@ -2,7 +2,7 @@
   "name": "tiny-readdir",
   "repository": "github:fabiospampinato/tiny-readdir",
   "description": "A simple promisified recursive readdir function.",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",

package/src/index.ts

@@ -3,6 +3,7 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
+import {isFunction} from './utils';
 import type {Promisable, Options, ResultDirectory, ResultDirectories, Result} from './types';
 
 /* MAIN */
@@ -12,7 +13,8 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
   const followSymlinks = options?.followSymlinks ?? false;
   const maxDepth = options?.depth ?? Infinity;
   const maxPaths = options?.limit ?? Infinity;
-  const isIgnored = options?.ignore ?? (() => false);
+  const ignore = options?.ignore ?? (() => false);
+  const isIgnored = isFunction ( ignore ) ? ignore : ( targetPath: string ) => ignore.test ( targetPath );
   const signal = options?.signal ?? { aborted: false };
   const directories: string[] = [];
   const files: string[] = [];

package/src/types.ts

@@ -9,7 +9,7 @@ type Options = {
   depth?: number,
   limit?: number,
   followSymlinks?: boolean,
-  ignore?: ( targetPath: string ) => boolean,
+  ignore?: (( targetPath: string ) => boolean) | RegExp,
   signal?: { aborted: boolean }
 };
 

package/src/utils.ts

@@ -0,0 +1,12 @@
+
+/* MAIN */
+
+const isFunction = ( value: unknown ): value is Function => {
+
+  return ( typeof value === 'function' );
+
+};
+
+/* EXPORT */
+
+export {isFunction};