Class ContainerReflection`Abstract`

Hierarchy

Models.Reflection
- ContainerReflection
  - Models.DeclarationReflection
  - Models.ProjectReflection

Index

Constructors

constructor

new ContainerReflection(name, kind, parent?): Models.ContainerReflection
Parameters
- name: string
- kind: ReflectionKind
- Optional parent: Models.Reflection
Returns Models.ContainerReflection
Inherited from Reflection.constructor
- Defined in src/lib/models/reflections/abstract.ts:322

Properties

flags

flags: Models.ReflectionFlags = ...

id

id: number

Unique id of this reflection.

kind

kind: ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

`Readonly` `Abstract` variant

variant: keyof ReflectionVariant

Discriminator representing the type of reflection represented by this object.

`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?: Models.ReflectionCategory[]

All children grouped by their category.

`Optional` children

children?: Models.DeclarationReflection[]

The children of this reflection.

`Optional` comment

comment?: Models.Comment

The parsed documentation comment attached to this reflection.

`Optional` groups

groups?: Models.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.

`Optional` parent

parent?: Models.Reflection

The reflection this reflection is a child of.

`Optional` 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

project

get project(): Models.ProjectReflection
Returns Models.ProjectReflection
Inherited from Reflection.project
- Defined in src/lib/models/reflections/abstract.ts:279

Methods

fromObject

fromObject(de, obj): void
Parameters
- de: Deserializer
- obj: JSONOutput.ContainerReflection
Returns void
Overrides Reflection.fromObject
- Defined in src/lib/models/reflections/container.ts:54

getAlias

getAlias(): string
Return an url safe alias for this reflection.

Returns string
Inherited from Reflection.getAlias
- Defined in src/lib/models/reflections/abstract.ts:392

getChildByName

getChildByName(arg): undefined | Models.Reflection
Return a child by its name.
Parameters
- arg: string | string[]
Returns undefined | Models.Reflection
The found child or undefined.
Inherited from Reflection.getChildByName
- Defined in src/lib/models/reflections/abstract.ts:444

getChildrenByKind

getChildrenByKind(kind): Models.DeclarationReflection[]
Return a list of all children of a certain kind.
Parameters
- kind: ReflectionKind
  
  The desired kind of children.
Returns Models.DeclarationReflection[]
An array containing all children with the desired kind.
- Defined in src/lib/models/reflections/container.ts:33

getFriendlyFullName

getFriendlyFullName(): string
Return the full name of this reflection, with signature names dropped if possible without introducing ambiguity in the name.

Returns string
Inherited from Reflection.getFriendlyFullName
- Defined in src/lib/models/reflections/abstract.ts:363

getFullName

getFullName(separator?): 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.
Inherited from Reflection.getFullName
- Defined in src/lib/models/reflections/abstract.ts:351

hasComment

hasComment(): boolean
Has this reflection a visible comment?

Returns boolean
TRUE when this reflection has a visible comment.
Inherited from Reflection.hasComment
- Defined in src/lib/models/reflections/abstract.ts:430

hasGetterOrSetter

hasGetterOrSetter(): boolean
Returns boolean
Inherited from Reflection.hasGetterOrSetter
- Defined in src/lib/models/reflections/abstract.ts:434

isDeclaration

isDeclaration(): this is Models.DeclarationReflection
Returns this is Models.DeclarationReflection
Inherited from Reflection.isDeclaration
- Defined in src/lib/models/reflections/abstract.ts:472

isDeprecated

isDeprecated(): boolean
Check if this reflection or any of its parents have been marked with the @deprecated tag.

Returns boolean
Inherited from Reflection.isDeprecated
- Defined in src/lib/models/reflections/abstract.ts:479

isProject

isProject(): this is Models.ProjectReflection
Return whether this reflection is the root / project reflection.

Returns this is Models.ProjectReflection
Inherited from Reflection.isProject
- Defined in src/lib/models/reflections/abstract.ts:469

kindOf

kindOf(kind): boolean
Test whether this reflection is of the given kind.
Parameters
- kind: ReflectionKind | ReflectionKind[]
Returns boolean
Inherited from Reflection.kindOf
- Defined in src/lib/models/reflections/abstract.ts:337

setFlag

setFlag(flag, value?): void
Set a flag on this reflection.
Parameters
- flag: ReflectionFlag
- value: boolean = true
Returns void
Inherited from Reflection.setFlag
- Defined in src/lib/models/reflections/abstract.ts:385

toObject

toObject(serializer): JSONOutput.ContainerReflection
Parameters
- serializer: Serializer
Returns JSONOutput.ContainerReflection
Overrides Reflection.toObject
- Defined in src/lib/models/reflections/container.ts:45

toString

toString(): string
Return a string representation of this reflection.

Returns string
Inherited from Reflection.toString
- Defined in src/lib/models/reflections/abstract.ts:521

toStringHierarchy

toStringHierarchy(indent?): string
Return a string representation of this reflection and all of its children.
Parameters
- indent: string = ""
  
  Used internally to indent child reflections.
Returns string
Inherited from Reflection.toStringHierarchy
- Defined in src/lib/models/reflections/abstract.ts:530

traverse

traverse(callback): 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.26.

The given callback will be invoked for all children, signatures and type parameters attached to this reflection.
Parameters
- callback: TraverseCallback
  
  The callback function that should be applied for each child reflection.
Returns void
Overrides Reflection.traverse
- Defined in src/lib/models/reflections/container.ts:37

visit

visit(visitor): void
Parameters
- visitor: ReflectionVisitor
Returns void
Inherited from Reflection.visit
- Defined in src/lib/models/reflections/abstract.ts:514

Class ContainerReflectionAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

kind: ReflectionKind

Optional parent: Models.Reflection

Returns Models.ContainerReflection

Properties

flags

id

kind

name

Readonly Abstract variant

Optional anchor

Optional categories

Optional children

Optional comment

Optional groups

Optional hasOwnDocument

Optional parent

Optional url

Accessors

project

Returns Models.ProjectReflection

Methods

fromObject

Parameters

de: Deserializer

obj: JSONOutput.ContainerReflection

Returns void

getAlias

Returns string

getChildByName

Parameters

arg: string | string[]

Returns undefined | Models.Reflection

getChildrenByKind

Parameters

kind: ReflectionKind

Returns Models.DeclarationReflection[]

getFriendlyFullName

Returns string

getFullName

Parameters

separator: string = "."

Returns string

hasComment

Returns boolean

hasGetterOrSetter

Returns boolean

isDeclaration

Returns this is Models.DeclarationReflection

isDeprecated

Returns boolean

isProject

Returns this is Models.ProjectReflection

kindOf

Parameters

kind: ReflectionKind | ReflectionKind[]

Returns boolean

setFlag

Parameters

flag: ReflectionFlag

value: boolean = true

Returns void

toObject

Parameters

serializer: Serializer

Returns JSONOutput.ContainerReflection

toString

Returns string

toStringHierarchy

Parameters

Class ContainerReflection`Abstract`

`Optional` parent: Models.Reflection

`Readonly` `Abstract` variant

`Optional` anchor

`Optional` categories

`Optional` children

`Optional` comment

`Optional` groups

`Optional` hasOwnDocument

`Optional` parent

`Optional` url