UNPKG

2 kBTypeScriptView Raw
1import { type SomeType, type ReferenceType } from "../types";
2import { Reflection, type TraverseCallback } from "./abstract";
3import type { ParameterReflection } from "./parameter";
4import type { TypeParameterReflection } from "./type-parameter";
5import type { DeclarationReflection } from "./declaration";
6import type { ReflectionKind } from "./kind";
7import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
8import { SourceReference } from "../sources/file";
9/**
10 * @category Reflections
11 */
12export declare class SignatureReflection extends Reflection {
13 readonly variant = "signature";
14 constructor(name: string, kind: SignatureReflection["kind"], parent: DeclarationReflection);
15 kind: ReflectionKind.SetSignature | ReflectionKind.GetSignature | ReflectionKind.IndexSignature | ReflectionKind.CallSignature | ReflectionKind.ConstructorSignature;
16 parent: DeclarationReflection;
17 /**
18 * A list of all source files that contributed to this reflection.
19 */
20 sources?: SourceReference[];
21 parameters?: ParameterReflection[];
22 typeParameters?: TypeParameterReflection[];
23 type?: SomeType;
24 /**
25 * A type that points to the reflection that has been overwritten by this reflection.
26 *
27 * Applies to interface and class members.
28 */
29 overwrites?: ReferenceType;
30 /**
31 * A type that points to the reflection this reflection has been inherited from.
32 *
33 * Applies to interface and class members.
34 */
35 inheritedFrom?: ReferenceType;
36 /**
37 * A type that points to the reflection this reflection is the implementation of.
38 *
39 * Applies to class members.
40 */
41 implementationOf?: ReferenceType;
42 traverse(callback: TraverseCallback): void;
43 /**
44 * Return a string representation of this reflection.
45 */
46 toString(): string;
47 toObject(serializer: Serializer): JSONOutput.SignatureReflection;
48 fromObject(de: Deserializer, obj: JSONOutput.SignatureReflection): void;
49}