A group of reflections. All reflections in a group are of the same kind.

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

Hierarchy

  • ReflectionGroup

Constructors

  • Create a new ReflectionGroup instance.

    Parameters

    • title: string

      The title of this group.

    Returns ReflectionGroup

Properties

categories?: ReflectionCategory[]

Categories contained within this group.

children: DeclarationReflection[] = []

All reflections of this group.

title: string

The title, a string representation of the typescript kind, of this group.

Methods

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

    Returns boolean

Generated using TypeDoc