Hierarchy

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.

children?: undefined
childrenNodes?: ANodeReflection[]
comment?: Comment

The parsed documentation comment attached to this reflection.

content: string
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.

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.

kind: ReflectionKind

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

label?: string

Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/) Added by the CommentPlugin during resolution.

module: Module
name: string

The symbol name of this reflection.

namedPath: string
originalName: string

The original name of the TypeScript declaration.

parent: Parent = module
relevanceBoost?: number

A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when boosting search relevance scores at runtime. May be modified by plugins.

sourceFilePath: string
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

  • get project(): ProjectReflection
  • Returns ProjectReflection

Methods

  • Try to find a reflection by its name.

    Returns

    The found reflection or null.

    Deprecated

    This method not be used, it naively splits the name by a . and searches recursively up the parent tree, which is not how any other name resolver works. If you are currently using this and need another method, please open an issue. For tests getChildByName should generally be sufficient.

    Parameters

    • arg: string | string[]

    Returns undefined | Reflection

  • Return an url safe alias for this reflection.

    Returns string

  • Return a child by its name.

    Returns

    The found child or undefined.

    Parameters

    • arg: string | string[]

    Returns undefined | Reflection

  • Return a list of all children of a certain kind.

    Returns

    An array containing all children with the desired kind.

    Parameters

    • kind: ReflectionKind

      The desired kind of children.

    Returns DeclarationReflection[]

  • Return the full name of this reflection, with signature names dropped if possible without introducing ambiguity in the name.

    Returns 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.

    Returns

    The full name of this reflection.

    Parameters

    • Optional separator: string

      Separator used to join the names of the reflections.

    Returns string

  • Has this reflection a visible comment?

    Returns

    TRUE when this reflection has a visible comment.

    Returns boolean

  • Returns boolean

  • Check if this reflection has been marked with the @deprecated tag.

    Returns boolean

  • Return whether this reflection is the root / project reflection.

    Returns this is ProjectReflection

  • Test whether this reflection is of the given kind.

    Parameters

    • kind: ReflectionKind | ReflectionKind[]

    Returns boolean

  • Set a flag on this reflection.

    Parameters

    • flag: ReflectionFlag
    • Optional value: boolean

    Returns void

  • Parameters

    • serializer: Serializer

    Returns ContainerReflection

  • Return a string representation of this reflection.

    Returns string

  • Return a string representation of this reflection and all of its children.

    Parameters

    • Optional indent: string

      Used internally to indent child reflections.

    Returns string

Generated using TypeDoc