• Preparing search index...
  • The search index is not available
Tidyscripts Docs
  • Tidyscripts Docs
  • node
  • generic_hierarchical_embedder
  • directory_structure
  • getDirectoryStructure

Function getDirectoryStructure

  • getDirectoryStructure(rootPath, options?): DirectoryNode
  • Recursively builds a hierarchical representation of a directory structure

    Parameters

    • rootPath: string

      Absolute path to start directory

    • options: DirectoryStructureOptions = {}

      Traversal options

    Returns DirectoryNode

    Hierarchical structure of files and directories (no file content)

    Example

    const structure = getDirectoryStructure('/path/to/project', {
    includeHidden: false,
    fileExtensions: ['.ts', '.js'],
    maxDepth: 5
    });
    • Defined in packages/ts_node/src/generic_hierarchical_embedder/directory_structure.ts:50

Settings

Member Visibility
Tidyscripts Docs
  • Loading...

Generated using TypeDoc