A category of reflections.

Reflection categories are created by the ┬┤CategoryPlugin┬┤ in the resolving phase of the dispatcher. The main purpose of categories is to be able to more easily render human readable children lists in templates.

Hierarchy

  • ReflectionCategory

Constructors

  • Create a new ReflectionCategory instance.

    Parameters

    • title: string

      The title of this category.

    Returns ReflectionCategory

Properties

children: DeclarationReflection[] = []

All reflections of this category.

title: string

The title, a string representation of this category.

Methods

  • allChildrenHaveOwnDocument(): boolean
  • Do all children of this category have a separate document?

    Returns boolean

Generated using TypeDoc