typedoc
Version:
Create api documentation for TypeScript projects.
31 lines (30 loc) • 1.25 kB
TypeScript
import type { SomeType } from "./types.js";
import { Reflection, type TraverseCallback } from "./Reflection.js";
import type { DeclarationReflection } from "./DeclarationReflection.js";
import type { Deserializer, JSONOutput, Serializer } from "#serialization";
import type { SignatureReflection } from "./SignatureReflection.js";
/**
* Modifier flags for type parameters, added in TS 4.7
* @enum
*/
export declare const VarianceModifier: {
readonly in: "in";
readonly out: "out";
readonly inOut: "in out";
};
export type VarianceModifier = (typeof VarianceModifier)[keyof typeof VarianceModifier];
/**
* @category Reflections
*/
export declare class TypeParameterReflection extends Reflection {
readonly variant = "typeParam";
parent?: DeclarationReflection | SignatureReflection;
type?: SomeType;
default?: SomeType;
varianceModifier?: VarianceModifier;
constructor(name: string, parent: Reflection, varianceModifier: VarianceModifier | undefined);
isTypeParameter(): this is TypeParameterReflection;
toObject(serializer: Serializer): JSONOutput.TypeParameterReflection;
fromObject(de: Deserializer, obj: JSONOutput.TypeParameterReflection): void;
traverse(_callback: TraverseCallback): void;
}