directory-tree 3.1.0 → 3.2.0

package/README.md

@@ -166,6 +166,33 @@ photos
 }
 ```
 
+## Adding custom fields
+You can easily extend a `DirectoryTree` object with custom fields by adding them to the custom field.
+For example add an `id` based on the path of a `DirectoryTree` object for each directory and file like so:
+```
+import { createHash } from 'crypto';
+import * as directoryTree from 'directory-tree';
+import { DirectoryTree, DirectoryTreeOptions, DirectoryTreeCallback } from 'directory-tree';
+
+const callback: DirectoryTreeCallback = (
+            item: DirectoryTree,
+            path: string
+        ) => {
+            item.custom.id = createHash('sha1').update(path).digest('base64');
+        };
+
+const dirTree: DirectoryTree & { id?: string } = directoryTree(
+    "<your-directory-path>",
+    {},
+    callback,
+    callback
+);
+
+// to explore the object with the new custom fields
+console.log(JSON.stringify(dirTree, null, 2));
+
+```
+
 ## Note
 
 Device, FIFO and socket files are ignored.

package/index.d.ts

@@ -18,6 +18,7 @@ declare namespace directoryTree {
     children ? : DirectoryTree[];
     extension?: string;
     isSymbolicLink?: boolean;
+    custom: { [key: string]: any };
   }
   export interface DirectoryTreeOptions {
     normalizePath ? : boolean;

package/package.json

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