Interface SignatureReflection

interface SignatureReflection {
    flags: JSONOutput.ReflectionFlags;
    id: number;
    kind: 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[];
}

Hierarchy

Properties

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

Properties

flags

flags: JSONOutput.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 variant

variant: "signature" = "signature"

Optional comment

comment?: JSONOutput.Comment

The parsed documentation comment attached to this reflection.

Optional implementationOf

implementationOf?: JSONOutput.ReferenceType

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

Applies to class members.

Optional inheritedFrom

inheritedFrom?: JSONOutput.ReferenceType

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

Applies to interface and class members.

Optional overwrites

overwrites?: JSONOutput.ReferenceType

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

Applies to interface and class members.

Optional parameters

parameters?: JSONOutput.ParameterReflection[]

Optional sources

sources?: JSONOutput.SourceReference[]

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

Optional type

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

Optional typeParameter

typeParameter?: JSONOutput.TypeParameterReflection[]

Settings

Member Visibility

Theme

On This Page

flagsidkindnamevariantcommentimplementationOfinheritedFromoverwritesparameterssourcestypetypeParameter