path-treeify 1.1.0-beta.94a5d17 → 1.2.0

package/dist/types/index.d.ts

@@ -1,40 +1,93 @@
+/** A filter function that determines whether a directory should be included in the tree */
 type FilterFunction = (params: {
     name: string;
     dirPath: string;
 }) => boolean;
+/** Constructor options for PathTreeify */
 interface PathTreeifyProps {
     base: string;
     filter?: FilterFunction;
 }
+/** Represents a single node (directory) in the path tree */
 declare class PathTreeNode {
+    /** The root base path used to resolve absolute paths */
     private base;
+    /** Reference to the parent node; null for the root node */
     parent: PathTreeNode | null;
+    /** The directory name of this node (not a full path) */
     value: string;
+    /** Child nodes representing subdirectories */
     children: PathTreeNode[];
     constructor(base: string);
+    /**
+     * Walks up the parent chain to compute this node's relative and absolute paths.
+     * @returns An object containing the relative path from base and the absolute path
+     */
     getPath(): {
         relative: string;
         absolute: string;
     };
 }
+/** Builds a tree of directory nodes rooted at a given base path */
 export declare class PathTreeify {
+    /** The root directory to scan */
     private base;
+    /** Optional filter applied to each directory during traversal */
     private filter?;
     constructor({ filter, base }: Partial<PathTreeifyProps>);
+    /**
+     * Validates that the provided filter is a function, accepts one parameter,
+     * and returns a boolean. Throws a TypeError if any condition is violated.
+     */
     private validateFilter;
+    /**
+     * Creates and optionally attaches a new PathTreeNode to a parent.
+     * @param parent - The parent node to attach to, or null for the root
+     */
     private initNode;
+    /**
+     * Recursively reads a directory and builds child nodes for each subdirectory.
+     * Applies the instance-level filter if one is set.
+     * @param dirPath - Absolute path of the directory to read
+     * @param parent - The parent node to attach children to
+     */
     private buildChildren;
+    /**
+     * Validates that each entry in the array is a string pointing to
+     * an accessible directory relative to the base path.
+     * @param relativeDirNames - Array of relative directory path strings to validate
+     */
     private checkRelativePaths;
+    /**
+     * Strips leading and trailing slashes from each directory name
+     * and removes any resulting empty strings.
+     */
     private formatDirnames;
+    /** Returns the names of all immediate subdirectories under the base path */
     private getAllDirNamesUnderBase;
+    /**
+     * Builds a tree rooted at base, containing only the specified subdirectories.
+     * @param dirNames - Relative directory names to include as top-level nodes
+     */
     private buildByDirNames;
+    /**
+     * Builds a tree using only the subdirectories under base that pass the given filter.
+     * @param filter - A predicate applied to each top-level directory name
+     */
     private buildByFilter;
+    /**
+     * Computes the relative and absolute paths for a given node
+     * by walking up the parent chain.
+     */
     getPathBy(node: PathTreeNode): {
         relative: string;
         absolute: string;
     };
+    /** Overload: build the tree from an explicit list of relative directory names */
     buildBy(dirNames: string[]): PathTreeNode;
+    /** Overload: build the tree from a predicate applied to top-level directory names */
     buildBy(filter: (dirName: string) => boolean): PathTreeNode;
+    /** Builds a full tree from all immediate subdirectories under the base path */
     build(): PathTreeNode;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-treeify",
-  "version": "1.1.0-beta.94a5d17",
+  "version": "1.2.0",
   "description": "Convert a path or an array of paths into a tree-structured JavaScript object, where each node has a `parent` property that holds a circular reference to its parent node.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",