Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SignatureReflection

Hierarchy

Implements

Index

Constructors

constructor

Properties

anchor

anchor: string

The name of the anchor of this child.

comment

comment: Comment

The parsed documentation comment attached to this reflection.

cssClasses

cssClasses: string

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

decorates

decorates: Type[]

A list of all types that are decorated by this reflection.

decorators

decorators: Decorator[]

A list of all decorators attached to this reflection.

flags

flags: ReflectionFlags = []

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.

id

id: number

Unique id of this reflection.

implementationOf

implementationOf: Type

A type that points to the reflection this reflection is the implementation of.

Applies to class members.

inheritedFrom

inheritedFrom: Type

A type that points to the reflection this reflection has been inherited from.

Applies to interface and class members.

kind

The kind of this reflection.

kindString

kindString: string

The human readable string representation of the kind of this reflection.

name

name: string = ""

The symbol name of this reflection.

originalName

originalName: string

The original name of the TypeScript declaration.

overwrites

overwrites: Type

A type that points to the reflection that has been overwritten by this reflection.

Applies to interface and class members.

parameters

parameters: ParameterReflection[]

parent

sources

sources: SourceReference[]

A list of all source files that contributed to this reflection.

type

type: Type

typeParameters

typeParameters: TypeParameterReflection[]

url

url: string

The url of this reflection in the generated documentation.

Methods

findReflectionByName

getAlias

  • getAlias(): string

getChildByName

getFullName

  • getFullName(separator?: string): string

getParameterTypes

  • getParameterTypes(): Type[]

hasComment

  • hasComment(): boolean

hasGetterOrSetter

  • hasGetterOrSetter(): boolean

isProject

  • isProject(): boolean

kindOf

setFlag

toObject

  • toObject(): any

toString

  • toString(): string

toStringHierarchy

  • toStringHierarchy(indent?: string): string

traverse

Generated using TypeDoc