Interface SignatureReflection

interface SignatureReflection {
    flags: JSONOutput.ReflectionFlags;
    id: Models.ReflectionId;
    kind: Models.ReflectionKind;
    name: string;
    variant: "signature";
    comment?: JSONOutput.Comment;
    implementationOf?: JSONOutput.ReferenceType;
    inheritedFrom?: JSONOutput.ReferenceType;
    overwrites?: JSONOutput.ReferenceType;
    parameters?: JSONOutput.ParameterReflection[];
    sources?: JSONOutput.SourceReference[];
    type?:
        | JSONOutput.LiteralType
        | JSONOutput.UnknownType
        | JSONOutput.ReferenceType
        | JSONOutput.OptionalType
        | JSONOutput.ArrayType
        | JSONOutput.ConditionalType
        | JSONOutput.IndexedAccessType
        | JSONOutput.InferredType
        | JSONOutput.IntersectionType
        | JSONOutput.IntrinsicType
        | JSONOutput.MappedType
        | JSONOutput.PredicateType
        | JSONOutput.QueryType
        | JSONOutput.ReflectionType
        | JSONOutput.RestType
        | JSONOutput.TemplateLiteralType
        | JSONOutput.TupleType
        | NamedTupleMemberType
        | JSONOutput.TypeOperatorType
        | JSONOutput.UnionType;
    typeParameter?: JSONOutput.TypeParameterReflection[];
    typeParameters?: JSONOutput.TypeParameterReflection[];
}

Hierarchy

  • Omit<JSONOutput.Reflection, "variant">
  • S<
        Models.SignatureReflection,
        | "variant"
        | "sources"
        | "parameters"
        | "typeParameters"
        | "type"
        | "overwrites"
        | "inheritedFrom"
        | "implementationOf",
    >
    • SignatureReflection

Properties

flags id kind name variant comment? implementationOf? inheritedFrom? overwrites? parameters? sources? type? typeParameter? typeParameters?

Properties

flags

flags: JSONOutput.ReflectionFlags

id

id: Models.ReflectionId

Unique id of this reflection.

kind

kind: Models.ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

Readonlyvariant

variant: "signature"

Discriminator representing the type of reflection represented by this object.

Optionalcomment

comment?: JSONOutput.Comment

The parsed documentation comment attached to this reflection.

OptionalimplementationOf

implementationOf?: JSONOutput.ReferenceType

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

Applies to class members.

OptionalinheritedFrom

inheritedFrom?: JSONOutput.ReferenceType

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

Applies to interface and class members.

Optionaloverwrites

overwrites?: JSONOutput.ReferenceType

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

Applies to interface and class members.

Optionalparameters

parameters?: JSONOutput.ParameterReflection[]

Optionalsources

sources?: JSONOutput.SourceReference[]

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

Optionaltype

type?:
    | JSONOutput.LiteralType
    | JSONOutput.UnknownType
    | JSONOutput.ReferenceType
    | JSONOutput.OptionalType
    | JSONOutput.ArrayType
    | JSONOutput.ConditionalType
    | JSONOutput.IndexedAccessType
    | JSONOutput.InferredType
    | JSONOutput.IntersectionType
    | JSONOutput.IntrinsicType
    | JSONOutput.MappedType
    | JSONOutput.PredicateType
    | JSONOutput.QueryType
    | JSONOutput.ReflectionType
    | JSONOutput.RestType
    | JSONOutput.TemplateLiteralType
    | JSONOutput.TupleType
    | NamedTupleMemberType
    | JSONOutput.TypeOperatorType
    | JSONOutput.UnionType

OptionaltypeParameter

typeParameter?: JSONOutput.TypeParameterReflection[]

Deprecated

in 0.26, replaced with typeParameters

OptionaltypeParameters

typeParameters?: JSONOutput.TypeParameterReflection[]

Settings

Member Visibility

On This Page

Properties