Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReflectionGroup

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

Index

Constructors

constructor

Properties

Optional allChildrenAreExternal

allChildrenAreExternal: undefined | false | true

Are all children external members?

Optional allChildrenAreInherited

allChildrenAreInherited: undefined | false | true

Are all children inherited members?

Optional allChildrenArePrivate

allChildrenArePrivate: undefined | false | true

Are all children private members?

Optional allChildrenAreProtectedOrPrivate

allChildrenAreProtectedOrPrivate: undefined | false | true

Are all children private or protected members?

allChildrenHaveOwnDocument

allChildrenHaveOwnDocument: Function

Do all children of this group have a separate document?

A bound representation of the ┬┤ReflectionGroup.getAllChildrenHaveOwnDocument┬┤ that can be used within templates.

children

children: Reflection[] = []

All reflections of this group.

Optional cssClasses

cssClasses: undefined | string

A list of generated css classes that should be applied to representations of this group in the generated markup.

kind

The original typescript kind of the children of this group.

Optional someChildrenAreExported

someChildrenAreExported: undefined | false | true

Are any children exported declarations?

title

title: string

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

Methods

Private getAllChildrenHaveOwnDocument

  • getAllChildrenHaveOwnDocument(): boolean

toObject

  • toObject(): any
  • Return a raw object representation of this reflection group.

    deprecated

    Use serializers instead

    Returns any

Generated using TypeDoc