directory-tree 3.2.1 → 3.3.1

package/README.md

@@ -178,7 +178,7 @@ const callback: DirectoryTreeCallback = (
             item: DirectoryTree,
             path: string
         ) => {
-            item.custom.id = createHash('sha1').update(path).digest('base64');
+            item.custom = {id: createHash('sha1').update(path).digest('base64')};
         };
 
 const dirTree: DirectoryTree & { id?: string } = directoryTree(

package/index.d.ts

@@ -1,34 +1,48 @@
-import { Stats } from 'fs';
+import { Stats } from "fs";
 
-declare function directoryTree(
+interface IObj {
+  [key: string]: any;
+}
+
+declare function directoryTree<
+  TCustomFile extends IObj = IObj,
+  TCustomDir extends IObj = IObj,
+  TCustomResult = TCustomFile & TCustomDir
+>(
   path: string,
-  options ? : directoryTree.DirectoryTreeOptions,
-  onEachFile ? : directoryTree.DirectoryTreeCallback,
-  onEachDirectory ? : directoryTree.DirectoryTreeCallback,
-): directoryTree.DirectoryTree;
+  options?: directoryTree.DirectoryTreeOptions,
+  onEachFile?: directoryTree.DirectoryTreeCallback<TCustomFile>,
+  onEachDirectory?: directoryTree.DirectoryTreeCallback<TCustomDir>
+): directoryTree.DirectoryTree<TCustomResult>;
 
 export as namespace directoryTree;
 
 declare namespace directoryTree {
-  export interface DirectoryTree {
+  export interface DirectoryTree<C extends IObj = IObj> {
     path: string;
     name: string;
     size: number;
     type: "directory" | "file";
-    children ? : DirectoryTree[];
+    children?: DirectoryTree<C>[];
     extension?: string;
     isSymbolicLink?: boolean;
-    custom: { [key: string]: any };
+    custom: C;
   }
+
   export interface DirectoryTreeOptions {
-    normalizePath ? : boolean;
-    exclude ? : RegExp | RegExp[];
-    attributes ? : (keyof Stats | "type" | "extension")[];
-    extensions ? : RegExp;
-    followSymlink ? : boolean;
-    depth ? : number;
+    normalizePath?: boolean;
+    exclude?: RegExp | RegExp[];
+    attributes?: (keyof Stats | "type" | "extension")[];
+    extensions?: RegExp;
+    followSymlinks?: boolean;
+    depth?: number;
   }
-  export type DirectoryTreeCallback = (item: DirectoryTree, path: string, stats: Stats) => void;
+
+  export type DirectoryTreeCallback<TCustom extends IObj = IObj> = (
+    item: DirectoryTree<TCustom>,
+    path: string,
+    stats: Stats
+  ) => void;
 }
 
 export = directoryTree;

package/lib/directory-tree.js

@@ -51,7 +51,7 @@ function isRegExp(regExp) {
 function directoryTree (path, options, onEachFile, onEachDirectory, currentDepth = 0) {
   options = options || {};
 
-  if (options.depth !== undefined && options.attributes.indexOf('size') !== -1) {
+  if (options.depth !== undefined && options.attributes && options.attributes.indexOf('size') !== -1) {
     throw new Error('usage of size attribute with depth option is prohibited');
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directory-tree",
-  "version": "3.2.1",
+  "version": "3.3.1",
   "description": "Convert a directory tree to a JS object.",
   "repository": {
     "type": "git",