Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

anchor?: string

The name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.

categories?: ReflectionCategory[]

All children grouped by their category.

The children of this reflection.

comment?: Comment

The parsed documentation comment attached to this reflection.

cssClasses?: string

A list of generated css classes that should be applied to representations of this reflection in the generated markup. TODO: Reflections shouldn't know about CSS. Move this property to the correct serializer.

decorates?: Type[]

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

decorators?: Decorator[]

A list of all decorators attached to this reflection.

directory: SourceDirectory = ...

The root directory of the project.

files: SourceFile[] = []

A list of all source files within the project.

flags: ReflectionFlags = ...
groups?: ReflectionGroup[]

All children grouped by their kind.

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. TODO: Reflections shouldn't know how they are rendered. Move this to the correct serializer.

id: number

Unique id of this reflection.

The kind of this reflection.

kindString?: string

The human readable string representation of the kind of this reflection. Set during the resolution phase by GroupPlugin

name: string

The name of the project.

The name can be passed as a command line argument or it is read from the package info. this.name is assigned in the Reflection class.

originalName: string

The original name of the TypeScript declaration.

packageInfo: any

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

parent?: Reflection

The reflection this reflection is a child of.

readme?: string

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

reflections: {} = {}

A list of all reflections within the project.

deprecated

use getReflectionById, this will eventually be removed. To iterate over all reflections, prefer getReflectionsByKind.

Type declaration

sources?: SourceReference[]

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

url?: string

The url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.

Accessors

Methods

  • findReflectionByName(arg: string | string[]): undefined | Reflection
  • getAlias(): string
  • getChildByName(arg: string | string[]): undefined | Reflection
  • getFriendlyFullName(): string
  • getFullName(separator?: string): string
  • Return the full name of this reflection. Intended for use in debugging. For log messages intended to be displayed to the user for them to fix, prefer getFriendlyFullName instead.

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

    Parameters

    • separator: string = "."

      Separator used to join the names of the reflections.

    Returns string

    The full name of this reflection.

  • getReflectionById(id: number): undefined | Reflection
  • hasComment(): boolean
  • hasGetterOrSetter(): boolean
  • registerReflection(reflection: Reflection, symbol?: Symbol): void
  • Registers the given reflection so that it can be quickly looked up by helper methods. Should be called for every reflection added to the project.

    Parameters

    Returns void

  • removeDanglingReferences(): void
  • When excludeNotExported is set, if a symbol is exported only under a different name there will be a reference which points to the symbol, but the symbol will not be converted and the rename will point to nothing. Warn the user if this happens.

    Returns void

  • Removes a reflection from the documentation. Can be used by plugins to filter reflections out of the generated documentation. Has no effect if the reflection is not present in the project.

    Parameters

    Returns void

  • toString(): string
  • toStringHierarchy(indent?: string): string

Generated using TypeDoc