TypeDoc API - v0.28.2

    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.ReferenceType
            | JSONOutput.ArrayType
            | JSONOutput.ConditionalType
            | JSONOutput.IndexedAccessType
            | JSONOutput.InferredType
            | JSONOutput.IntersectionType
            | JSONOutput.IntrinsicType
            | JSONOutput.LiteralType
            | JSONOutput.MappedType
            | JSONOutput.OptionalType
            | JSONOutput.PredicateType
            | JSONOutput.QueryType
            | JSONOutput.ReflectionType
            | JSONOutput.RestType
            | JSONOutput.TemplateLiteralType
            | JSONOutput.TupleType
            | NamedTupleMemberType
            | JSONOutput.TypeOperatorType
            | JSONOutput.UnionType
            | JSONOutput.UnknownType;
        typeParameters?: JSONOutput.TypeParameterReflection[];
    }

    Hierarchy

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

    Properties

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

    Properties

    flags: JSONOutput.ReflectionFlags
    id: Models.ReflectionId

    Unique id of this reflection.

    kind: Models.ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    variant: "signature"

    Discriminator representing the type of reflection represented by this object.

    comment?: JSONOutput.Comment

    The parsed documentation comment attached to this reflection.

    implementationOf?: JSONOutput.ReferenceType

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

    Applies to class members.

    inheritedFrom?: JSONOutput.ReferenceType

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

    Applies to interface and class members.

    overwrites?: JSONOutput.ReferenceType

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

    Applies to interface and class members.

    parameters?: JSONOutput.ParameterReflection[]
    sources?: JSONOutput.SourceReference[]

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

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

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR