Class SignatureReflection

Hierarchy (view full)

Models.Reflection
- SignatureReflection

Constructors

constructor

new SignatureReflection(name, kind, parent): Models.SignatureReflection
Parameters
- name: string
- kind:
      | CallSignature
      | IndexSignature
      | ConstructorSignature
      | GetSignature
      | SetSignature
- parent: Models.DeclarationReflection
Returns Models.SignatureReflection
Overrides Reflection.constructor
- Defined in models/reflections/signature.ts:22

Properties

flags

flags: Models.ReflectionFlags = ...

id

id: number

Unique id of this reflection.

kind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

parent

parent: Models.DeclarationReflection

The reflection this reflection is a child of.

project

project: Models.ProjectReflection

`Readonly`variant

variant = "signature"

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

comment?: Models.Comment

The parsed documentation comment attached to this reflection.

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

implementationOf?: Models.ReferenceType

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

Applies to class members.

`Optional`inheritedFrom

inheritedFrom?: Models.ReferenceType

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

Applies to interface and class members.

`Optional`overwrites

overwrites?: Models.ReferenceType

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

Applies to interface and class members.

`Optional`parameters

parameters?: Models.ParameterReflection[]

`Optional`sources

sources?: Models.SourceReference[]

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

`Optional`type

type?: Models.SomeType

`Optional`typeParameters

typeParameters?: Models.TypeParameterReflection[]

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

Methods

fromObject

fromObject(de, obj): void
Parameters
- de: Deserializer
- obj: JSONOutput.SignatureReflection
Returns void
Overrides Reflection.fromObject
- Defined in models/reflections/signature.ts:130

getAlias

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

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

getChildByName

getChildByName(arg): undefined | Models.Reflection
Return a child by its name.
Parameters
- arg: string | string[]
  The name hierarchy of the child to look for.
Returns undefined | Models.Reflection
The found child or undefined.
Inherited from Reflection.getChildByName
- Defined in models/reflections/abstract.ts:445

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 models/reflections/abstract.ts:361

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 models/reflections/abstract.ts:349

getUniqueAliasInPage

getUniqueAliasInPage(heading): string
Parameters
- heading: string
Returns string
Inherited from Reflection.getUniqueAliasInPage
- Defined in models/reflections/abstract.ts:401

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 models/reflections/abstract.ts:431

hasGetterOrSetter

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

isDeclaration

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

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 models/reflections/abstract.ts:483

isDocument

isDocument(): this is Models.DocumentReflection
Returns this is Models.DocumentReflection
Inherited from Reflection.isDocument
- Defined in models/reflections/abstract.ts:476

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 models/reflections/abstract.ts:470

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 models/reflections/abstract.ts:333

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 models/reflections/abstract.ts:383

toObject

toObject(serializer): JSONOutput.SignatureReflection
Parameters
- serializer: Serializer
Returns JSONOutput.SignatureReflection
Overrides Reflection.toObject
- Defined in models/reflections/signature.ts:116

toString

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

Returns string
Overrides Reflection.toString
- Defined in models/reflections/signature.ts:99

toStringHierarchy

toStringHierarchy(indent?): string
Return a string representation of this reflection and all of its children.

Note: This is intended as a debug tool only, output may change between patch versions.
Parameters
- indent: string = ""
  Used internally to indent child reflections.
Returns string
Inherited from Reflection.toStringHierarchy
- Defined in models/reflections/abstract.ts:536

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.27.

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 models/reflections/signature.ts:71

visit

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

Class SignatureReflection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Models.SignatureReflection

Properties

flags

id

kind

name

parent

project

Readonlyvariant

Optionalanchor

Optionalcomment

OptionalhasOwnDocument

OptionalimplementationOf

OptionalinheritedFrom

Optionaloverwrites

Optionalparameters

Optionalsources

Optionaltype

OptionaltypeParameters

Optionalurl

Methods

fromObject

Parameters

Returns void

getAlias

Returns string

getChildByName

Parameters

Returns undefined | Models.Reflection

getFriendlyFullName

Returns string

getFullName

Parameters

Returns string

getUniqueAliasInPage

Parameters

Returns string

hasComment

Returns boolean

hasGetterOrSetter

Returns boolean

isDeclaration

Returns this is Models.DeclarationReflection

isDeprecated

Returns boolean

isDocument

Returns this is Models.DocumentReflection

isProject

Returns this is Models.ProjectReflection

kindOf

Parameters

Returns boolean

setFlag

Parameters

Returns void

toObject

Parameters

Returns JSONOutput.SignatureReflection

toString

Returns string

toStringHierarchy

Parameters

Returns string

traverse

Parameters

Returns void

visit

Parameters

Returns void

Settings

On This Page

`Readonly`variant

`Optional`anchor

`Optional`comment

`Optional`hasOwnDocument

`Optional`implementationOf

`Optional`inheritedFrom

`Optional`overwrites

`Optional`parameters

`Optional`sources

`Optional`type

`Optional`typeParameters

`Optional`url