Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SourceDirectory

Exposes information about a directory containing source files.

One my access the root directory of a project through the ProjectReflection.directory property. Traverse through directories by utilizing the SourceDirectory.parent or SourceDirectory.directories properties.

Hierarchy

  • SourceDirectory

Index

Constructors

constructor

Properties

Optional dirName

dirName: undefined | string

The relative path from the root directory to this directory.

directories

directories: object

A list of all subdirectories.

Type declaration

files

files: SourceFile[] = []

A list of all files in this directory.

Optional groups

groups: ReflectionGroup[]

Optional name

name: undefined | string

The name of this directory.

Optional parent

The parent directory or undefined if this is a root directory.

Optional url

url: undefined | string

The url of the page displaying the directory contents.

Methods

getAllReflections

toString

  • toString(indent?: string): string
  • Return a string describing this directory and its contents.

    Parameters

    • Default value indent: string = ""

      Used internally for indention.

    Returns string

    A string representing this directory and all of its children.

Generated using TypeDoc