tiny-readdir 2.6.0 → 2.7.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { Dirent, Options, Result } from './types';
+import type { Dirent, Options, ResultDirectory, ResultDirectories, Result } from './types';
 declare const readdir: (rootPath: string, options?: Options) => Promise<Result>;
 export default readdir;
-export type { Dirent, Options, Result };
+export type { Dirent, Options, ResultDirectory, ResultDirectories, Result };

package/dist/index.js

@@ -2,15 +2,16 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { NOOP_PROMISE_LIKE } from './constants.js';
-import { isFunction, makeCounterPromise } from './utils.js';
+import { castArray, isFunction, makeCounterPromise } from './utils.js';
 /* MAIN */
 //TODO: Streamline the type of dirnmaps
 const readdir = (rootPath, options) => {
     const followSymlinks = options?.followSymlinks ?? false;
     const maxDepth = options?.depth ?? Infinity;
     const maxPaths = options?.limit ?? Infinity;
-    const ignore = options?.ignore ?? (() => false);
-    const isIgnored = isFunction(ignore) ? ignore : (targetPath) => ignore.test(targetPath);
+    const ignore = options?.ignore ?? [];
+    const ignores = castArray(ignore).map(ignore => isFunction(ignore) ? ignore : (targetPath) => ignore.test(targetPath));
+    const isIgnored = (targetPath) => ignores.some(ignore => ignore(targetPath));
     const signal = options?.signal ?? { aborted: false };
     const onDirents = options?.onDirents || (() => { });
     const directories = [];

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 type Callback = () => void;
+type ArrayMaybe<T> = T[] | T;
 type PromiseMaybe<T> = Promise<T> | T;
 type Dirent = {
     isFile: () => boolean;
@@ -15,7 +16,7 @@ type Options = {
     depth?: number;
     limit?: number;
     followSymlinks?: boolean;
-    ignore?: ((targetPath: string) => boolean) | RegExp;
+    ignore?: ArrayMaybe<((targetPath: string) => boolean) | RegExp>;
     signal?: {
         aborted: boolean;
     };

package/dist/utils.d.ts

@@ -1,8 +1,9 @@
 import type { Callback } from './types';
+declare const castArray: <T>(value: T | T[]) => T[];
 declare const isFunction: (value: unknown) => value is Function;
 declare const makeCounterPromise: () => {
     promise: Promise<void>;
     increment: Callback;
     decrement: Callback;
 };
-export { isFunction, makeCounterPromise };
+export { castArray, isFunction, makeCounterPromise };

package/dist/utils.js

@@ -1,6 +1,9 @@
 /* IMPORT */
 import makeNakedPromise from 'promise-make-naked';
 /* MAIN */
+const castArray = (value) => {
+    return Array.isArray(value) ? value : [value];
+};
 const isFunction = (value) => {
     return (typeof value === 'function');
 };
@@ -19,4 +22,4 @@ const makeCounterPromise = () => {
     return { promise, increment, decrement };
 };
 /* EXPORT */
-export { isFunction, makeCounterPromise };
+export { castArray, isFunction, makeCounterPromise };

package/package.json

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

package/src/index.ts

@@ -4,7 +4,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import {NOOP_PROMISE_LIKE} from './constants';
-import {isFunction, makeCounterPromise} from './utils';
+import {castArray, isFunction, makeCounterPromise} from './utils';
 import type {Dirent, Options, ResultDirectory, ResultDirectories, Result} from './types';
 
 /* MAIN */
@@ -16,8 +16,9 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
   const followSymlinks = options?.followSymlinks ?? false;
   const maxDepth = options?.depth ?? Infinity;
   const maxPaths = options?.limit ?? Infinity;
-  const ignore = options?.ignore ?? (() => false);
-  const isIgnored = isFunction ( ignore ) ? ignore : ( targetPath: string ) => ignore.test ( targetPath );
+  const ignore = options?.ignore ?? [];
+  const ignores = castArray ( ignore ).map ( ignore => isFunction ( ignore ) ? ignore : ( targetPath: string ) => ignore.test ( targetPath ) );
+  const isIgnored = ( targetPath: string ) => ignores.some ( ignore => ignore ( targetPath ) );
   const signal = options?.signal ?? { aborted: false };
   const onDirents = options?.onDirents || (() => {});
   const directories: string[] = [];
@@ -252,4 +253,4 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
 /* EXPORT */
 
 export default readdir;
-export type {Dirent, Options, Result};
+export type {Dirent, Options, ResultDirectory, ResultDirectories, Result};

package/src/types.ts

@@ -3,6 +3,8 @@
 
 type Callback = () => void;
 
+type ArrayMaybe<T> = T[] | T;
+
 type PromiseMaybe<T> = Promise<T> | T;
 
 /* MAIN */
@@ -23,7 +25,7 @@ type Options = {
   depth?: number,
   limit?: number,
   followSymlinks?: boolean,
-  ignore?: (( targetPath: string ) => boolean) | RegExp,
+  ignore?: ArrayMaybe<(( targetPath: string ) => boolean) | RegExp>,
   signal?: { aborted: boolean },
   onDirents?: ( dirents: Dirent[] ) => PromiseMaybe<undefined>
 };

package/src/utils.ts

@@ -6,6 +6,12 @@ import type {Callback} from './types';
 
 /* MAIN */
 
+const castArray = <T> ( value: T[] | T ): T[] => {
+
+  return Array.isArray ( value ) ? value : [value];
+
+};
+
 const isFunction = ( value: unknown ): value is Function => {
 
   return ( typeof value === 'function' );
@@ -40,4 +46,4 @@ const makeCounterPromise = (): { promise: Promise<void>, increment: Callback, de
 
 /* EXPORT */
 
-export {isFunction, makeCounterPromise};
+export {castArray, isFunction, makeCounterPromise};