Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Reflection

Base class for all reflection classes.

While generating a documentation, TypeDoc generates an instance of ProjectReflection as the root for all reflections within the project. All other reflections are represented by the DeclarationReflection class.

This base class exposes the basic properties one may use to traverse the reflection tree. You can use the children and parent properties to walk the tree. The groups property contains a list of all children grouped and sorted for being rendered.

Hierarchy

Index

Constructors

constructor

Properties

Private Optional _alias

_alias: undefined | string

Url safe alias for this reflection.

see

[[BaseReflection.getAlias]]

Private Optional _aliases

_aliases: string[]

Optional anchor

anchor: undefined | string

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

Optional comment

comment: Comment

The parsed documentation comment attached to this reflection.

Optional cssClasses

cssClasses: undefined | 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.

Optional decorates

decorates: Type[]

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

Optional decorators

decorators: Decorator[]

A list of all decorators attached to this reflection.

flags

flags: ReflectionFlags = new ReflectionFlags()

Optional hasOwnDocument

hasOwnDocument: undefined | false | true

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

id: number

Unique id of this reflection.

kind

The kind of this reflection.

Optional kindString

kindString: undefined | string

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

name

name: string = ""

The symbol name of this reflection.

originalName

originalName: string

The original name of the TypeScript declaration.

Optional parent

parent: Reflection

The reflection this reflection is a child of.

Optional sources

sources: SourceReference[]

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

Optional url

url: undefined | string

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

Methods

findReflectionByName

  • findReflectionByName(arg: string | string[]): Reflection | undefined

getAlias

  • getAlias(): string

getChildByName

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.

hasComment

  • hasComment(): boolean

hasGetterOrSetter

  • hasGetterOrSetter(): boolean

isProject

  • isProject(): boolean

kindOf

setFlag

toObject

  • toObject(): any

toString

  • toString(): string

toStringHierarchy

  • toStringHierarchy(indent?: string): string
  • Return a string representation of this reflection and all of its children.

    Parameters

    • Default value indent: string = ""

      Used internally to indent child reflections.

    Returns string

traverse

  • Traverse all potential child reflections of this reflection.

    The given callback will be invoked for all children, signatures and type parameters attached to this reflection.

    Parameters

    • callback: TraverseCallback

      The callback function that should be applied for each child reflection.

    Returns void

Generated using TypeDoc