typedoc/dist/lib/models/reflections/signature.d.ts

Create api documentation for TypeScript projects.

import { type SomeType, type ReferenceType } from "../types.js";
import { Reflection, type TraverseCallback } from "./abstract.js";
import type { ParameterReflection } from "./parameter.js";
import type { TypeParameterReflection } from "./type-parameter.js";
import type { DeclarationReflection } from "./declaration.js";
import type { ReflectionKind } from "./kind.js";
import type { Serializer, JSONOutput, Deserializer } from "../../serialization/index.js";
import { SourceReference } from "../sources/file.js";
/**
 * @category Reflections
 */
export declare class SignatureReflection extends Reflection {
    readonly variant = "signature";
    constructor(name: string, kind: SignatureReflection["kind"], parent: DeclarationReflection);
    kind: ReflectionKind.SetSignature | ReflectionKind.GetSignature | ReflectionKind.IndexSignature | ReflectionKind.CallSignature | ReflectionKind.ConstructorSignature;
    parent: DeclarationReflection;
    /**
     * A list of all source files that contributed to this reflection.
     */
    sources?: SourceReference[];
    parameters?: ParameterReflection[];
    typeParameters?: TypeParameterReflection[];
    type?: SomeType;
    /**
     * A type that points to the reflection that has been overwritten by this reflection.
     *
     * Applies to interface and class members.
     */
    overwrites?: ReferenceType;
    /**
     * A type that points to the reflection this reflection has been inherited from.
     *
     * Applies to interface and class members.
     */
    inheritedFrom?: ReferenceType;
    /**
     * A type that points to the reflection this reflection is the implementation of.
     *
     * Applies to class members.
     */
    implementationOf?: ReferenceType;
    traverse(callback: TraverseCallback): void;
    /**
     * Return a string representation of this reflection.
     */
    toString(): string;
    toObject(serializer: Serializer): JSONOutput.SignatureReflection;
    fromObject(de: Deserializer, obj: JSONOutput.SignatureReflection): void;
}