Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProjectReflection

A reflection that represents the root of the project.

The project reflection acts as a global index, one may receive all reflections and source files of the processed project through this reflection.

Hierarchy

Index

Constructors

constructor

Properties

anchor

anchor: string

The name of the anchor of this child.

categories

categories: ReflectionCategory[]

All reflections categorized.

children

The children of this reflection.

comment

comment: Comment

The parsed documentation comment attached to this reflection.

cssClasses

cssClasses: string

A list of generated css classes that should be applied to representations of this reflection in the generated markup.

decorates

decorates: Type[]

A list of all types that are decorated by this reflection.

decorators

decorators: Decorator[]

A list of all decorators attached to this reflection.

directory

directory: SourceDirectory = new SourceDirectory()

The root directory of the project.

files

files: SourceFile[] = []

A list of all source files within the project.

flags

flags: ReflectionFlags = []

groups

groups: ReflectionGroup[]

All children grouped by their kind.

hasOwnDocument

hasOwnDocument: boolean

Is the url pointing to an individual document?

When FALSE, the url points to an anchor tag on a page of a different reflection.

id

id: number

Unique id of this reflection.

kind

The kind of this reflection.

kindString

kindString: string

The human readable string representation of the kind of this reflection.

name

name: string

The name of the project.

The name can be passed as a commandline argument or it is read from the package info.

originalName

originalName: string

The original name of the TypeScript declaration.

packageInfo

packageInfo: any

The parsed data of the package.json file of the project when found.

parent

parent: Reflection

The reflection this reflection is a child of.

readme

readme: string

The contents of the readme.md file of the project when found.

reflections

reflections: object

A list of all reflections within the project.

Type declaration

sources

sources: SourceReference[]

A list of all source files that contributed to this reflection.

symbolMapping

symbolMapping: object

Type declaration

  • [symbolId: number]: number

url

url: string

The url of this reflection in the generated documentation.

Methods

findReflectionByName

getAlias

  • getAlias(): string

getChildByName

getChildrenByKind

getFullName

  • getFullName(separator?: string): string
  • Return the full name of this reflection.

    The full name contains the name of this reflection and the names of all parent reflections.

    Parameters

    • Default value separator: string = "."

      Separator used to join the names of the reflections.

    Returns string

    The full name of this reflection.

getReflectionsByKind

hasComment

  • hasComment(): boolean

hasGetterOrSetter

  • hasGetterOrSetter(): boolean

isProject

  • isProject(): boolean

kindOf

setFlag

toObject

  • toObject(): any

toString

  • toString(): string

toStringHierarchy

  • toStringHierarchy(indent?: string): string

traverse

Generated using TypeDoc