KC's Workspace
    Preparing search index...

    Interface SignatureReflection

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

    Hierarchy (View Summary)

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

    Properties

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

    Properties

    comment?: Comment

    The parsed documentation comment attached to this reflection.

    flags: ReflectionFlags
    id: ReflectionId

    Unique id of this reflection.

    implementationOf?: ReferenceType

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

    Applies to class members.

    inheritedFrom?: ReferenceType

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

    Applies to interface and class members.

    kind: ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    overwrites?: ReferenceType

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

    Applies to interface and class members.

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

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

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

    Discriminator representing the type of reflection represented by this object.

    Settings

    Member Visibility

    On This Page

    Properties