TypeDoc API - v0.28.2

    Class SignatureReflection

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Methods

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

    • 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

    • 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.29.

      The given callback will be invoked for all children, signatures and type parameters attached to this reflection.

      Parameters

      Returns void

    Properties

    flags: Models.ReflectionFlags = ...

    Unique id of this reflection.

    kind:
        | CallSignature
        | IndexSignature
        | ConstructorSignature
        | GetSignature
        | SetSignature

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    The reflection this reflection is a child of.

    variant: "signature"

    Discriminator representing the type of reflection represented by this object.

    comment?: Models.Comment

    The parsed documentation comment attached to this reflection.

    implementationOf?: Models.ReferenceType

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

    Applies to class members.

    inheritedFrom?: Models.ReferenceType

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

    Applies to interface and class members.

    overwrites?: Models.ReferenceType

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

    Applies to interface and class members.

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

    typeParameters?: Models.TypeParameterReflection[]
    MMNEPVFCICPMFPCPTTAAATR