Interface SubFileData<CustomNode>

Represents metadata for a file or directory within the subtree traversal.

interface SubFileData<CustomNode extends Node> {
    dirNode: CustomNode;
    dirpath: string;
    file: string;
    path: string;
}

Type Parameters

CustomNode extends Node
Optional type describing the shape of the tree structure used in this traversal.

Hierarchy

BaseFileData<CustomNode>
- SubFileData

Index

Properties

dirNode dirpath file path

Properties

dirNode

dirNode: CustomNode

The parent directory node in the subtree. Available during onSubTree hook.

dirpath

dirpath: string

The absolute path of the directory containing this file. Available in all hooks.

file

file: string

The name of the file or directory (without path).

path

path: string

The absolute path to this file or directory.