Class PageReflection

Hierarchy

Constructors

constructor

Properties

anchor? categories? children? childrenNodes? comment? content cssClasses? flags groups? hasOwnDocument? id kind kindString? label? module name namedPath originalName parent relevanceBoost? sourceFilePath sources? url

Accessors

depth isModuleAppendix project

Methods

findReflectionByName getAlias getChildByName getChildrenByKind getFriendlyFullName getFullName hasComment hasGetterOrSetter isDeprecated isProject kindOf setFlag toObject toString toStringHierarchy traverse

Constructors

constructor

Properties

Optional anchor

anchor?: string

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

Optional categories

categories?: ReflectionCategory[]

All children grouped by their category.

Optional children

children?: undefined

Optional childrenNodes

childrenNodes?: ANodeReflection[]

Optional comment

comment?: Comment

The parsed documentation comment attached to this reflection.

Readonly content

content: string

Optional cssClasses

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

flags: ReflectionFlags

Optional groups

groups?: ReflectionGroup[]

All children grouped by their kind.

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

id

id: number

Unique id of this reflection.

kind

kind: ReflectionKind

The kind of this reflection.

Optional kindString

kindString?: string

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

Optional label

label?: string

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

Readonly module

module: Module

name

name: string

The symbol name of this reflection.

Readonly namedPath

namedPath: string

originalName

originalName: string

The original name of the TypeScript declaration.

parent

parent: Parent = module

Optional relevanceBoost

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.

Readonly sourceFilePath

sourceFilePath: string

Optional sources

sources?: SourceReference[]

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

Readonly url

url: string

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

Accessors

depth

isModuleAppendix

project

  • get project(): ProjectReflection

  • Returns ProjectReflection

Methods

findReflectionByName

  • 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

getAlias

  • Return an url safe alias for this reflection.

    Returns string

getChildByName

  • Return a child by its name.

    Returns

    The found child or undefined.

    Parameters

    • arg: string | string[]

    Returns undefined | Reflection

getChildrenByKind

  • 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[]

getFriendlyFullName

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

    Returns string

getFullName

  • 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

hasComment

  • Has this reflection a visible comment?

    Returns

    TRUE when this reflection has a visible comment.

    Returns boolean

hasGetterOrSetter

  • Returns boolean

isDeprecated

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

    Returns boolean

isProject

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

    Returns this is ProjectReflection

kindOf

  • Test whether this reflection is of the given kind.

    Parameters

    • kind: ReflectionKind | ReflectionKind[]

    Returns boolean

setFlag

  • Set a flag on this reflection.

    Parameters

    • flag: ReflectionFlag
    • Optional value: boolean

    Returns void

toObject

  • Parameters

    • serializer: Serializer

    Returns ContainerReflection

toString

  • Return a string representation of this reflection.

    Returns string

toStringHierarchy

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

    Parameters

    • Optional indent: string

      Used internally to indent child reflections.

    Returns string

traverse

Settings

Member Visibility

Theme

Generated using TypeDoc