Class DocumentReflection

Non-TS reflection type which is used to represent markdown documents included in the docs.

Hierarchy (View Summary)

Constructors

constructor

Methods

addChild fromObject getChildByName getFriendlyFullName getFullName hasComment hasGetterOrSetter isDeclaration isDeprecated isDocument isParameter isProject isReference kindOf setFlag toObject toString toStringHierarchy traverse visit

Properties

content flags frontmatter id kind name project variant anchor? children? comment? hasOwnDocument? parent? relevanceBoost? url?

Constructors

constructor

Methods

addChild

fromObject

getChildByName

getFriendlyFullName

getFullName

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

hasComment

hasGetterOrSetter

isDeclaration

isDeprecated

isDocument

isParameter

isProject

isReference

kindOf

setFlag

toObject

toString

toStringHierarchy

  • toStringHierarchy(indent?: string): string

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

    Note: This is intended as a debug tool only, output may change between patch versions.

    Parameters

    • indent: string = ""

      Used internally to indent child reflections.

    Returns string

traverse

  • traverse(callback: Models.TraverseCallback): void

  • Traverse most potential child reflections of this reflection.

    Note: This may not necessarily traverse child reflections contained within the type property of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.27.

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

    Parameters

    Returns void

visit

Properties

content

content: Models.CommentDisplayPart[]

The content to be displayed on the page for this reflection.

flags

flags: Models.ReflectionFlags = ...

frontmatter

frontmatter: Record<string, unknown>

Frontmatter included in document

id

id: Models.ReflectionId

Unique id of this reflection.

kind

kind: Models.ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

project

project: Models.ProjectReflection

Readonlyvariant

variant: "document"

Discriminator representing the type of reflection represented by this object.

Optionalanchor

anchor?: string

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

Optionalchildren

children?: Models.DocumentReflection[]

Child documents, if any are present.

Optionalcomment

comment?: Models.Comment

The parsed documentation comment attached to this reflection.

OptionalhasOwnDocument

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.

Optionalparent

parent?: Models.Reflection

The reflection this reflection is a child of.

OptionalrelevanceBoost

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.

Optionalurl

url?: string

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

Settings

Member Visibility

On This Page

Constructors
Methods
Properties