typedoc 0.24.8 → 0.25.1

package/dist/lib/models/reflections/abstract.js

@@ -205,6 +205,7 @@ var TraverseProperty;
  * This base class exposes the basic properties one may use to traverse the reflection tree.
  * You can use the {@link ContainerReflection.children} and {@link parent} properties to walk the tree. The {@link ContainerReflection.groups} property
  * contains a list of all children grouped and sorted for rendering.
+ * @category Reflections
  */
 class Reflection {
     get project() {
@@ -288,7 +289,7 @@ class Reflection {
             while (target.parent && !target.hasOwnDocument) {
                 target = target.parent;
             }
-            target._aliases || (target._aliases = new Map());
+            target._aliases ||= new Map();
             let suffix = "";
             if (!target._aliases.has(upperAlias)) {
                 target._aliases.set(upperAlias, 1);
@@ -353,11 +354,23 @@ class Reflection {
      * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
      */
     isDeprecated() {
-        if (this.comment?.getTag("@deprecated")) {
+        let signaturesDeprecated = false;
+        this.visit({
+            declaration(decl) {
+                if (decl.signatures &&
+                    decl.signatures.every((sig) => sig.comment?.getTag("@deprecated"))) {
+                    signaturesDeprecated = true;
+                }
+            },
+        });
+        if (signaturesDeprecated || this.comment?.getTag("@deprecated")) {
             return true;
         }
         return this.parent?.isDeprecated() ?? false;
     }
+    visit(visitor) {
+        visitor[this.variant]?.(this);
+    }
     /**
      * Return a string representation of this reflection.
      */

package/dist/lib/models/reflections/container.d.ts

@@ -4,6 +4,9 @@ import { ReflectionGroup } from "../ReflectionGroup";
 import type { ReflectionKind } from "./kind";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
 import type { DeclarationReflection } from "./declaration";
+/**
+ * @category Reflections
+ */
 export declare abstract class ContainerReflection extends Reflection {
     /**
      * The children of this reflection.

package/dist/lib/models/reflections/container.js

@@ -4,6 +4,9 @@ exports.ContainerReflection = void 0;
 const abstract_1 = require("./abstract");
 const ReflectionCategory_1 = require("../ReflectionCategory");
 const ReflectionGroup_1 = require("../ReflectionGroup");
+/**
+ * @category Reflections
+ */
 class ContainerReflection extends abstract_1.Reflection {
     /**
      * Return a list of all children of a certain kind.
@@ -32,7 +35,7 @@ class ContainerReflection extends abstract_1.Reflection {
     fromObject(de, obj) {
         super.fromObject(de, obj);
         this.children = de.reviveMany(obj.children, (child) => de.constructReflection(child));
-        this.groups = de.reviveMany(obj.groups, (group) => new ReflectionGroup_1.ReflectionGroup(group.title));
+        this.groups = de.reviveMany(obj.groups, (group) => new ReflectionGroup_1.ReflectionGroup(group.title, this));
         this.categories = de.reviveMany(obj.categories, (cat) => new ReflectionCategory_1.ReflectionCategory(cat.title));
     }
 }

package/dist/lib/models/reflections/declaration.d.ts

@@ -38,6 +38,7 @@ export declare enum ConversionFlags {
  *
  * All parts of a project are represented by DeclarationReflection instances. The actual
  * kind of a reflection is stored in its ´kind´ member.
+ * @category Reflections
  */
 export declare class DeclarationReflection extends ContainerReflection {
     readonly variant: "declaration" | "reference";

package/dist/lib/models/reflections/declaration.js

@@ -21,6 +21,7 @@ var ConversionFlags;
  *
  * All parts of a project are represented by DeclarationReflection instances. The actual
  * kind of a reflection is stored in its ´kind´ member.
+ * @category Reflections
  */
 class DeclarationReflection extends container_1.ContainerReflection {
     constructor() {

package/dist/lib/models/reflections/index.d.ts

@@ -1,5 +1,5 @@
 export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract";
-export type { TraverseCallback } from "./abstract";
+export type { TraverseCallback, ReflectionVisitor } from "./abstract";
 export { ContainerReflection } from "./container";
 export { DeclarationReflection, ConversionFlags } from "./declaration";
 export type { DeclarationHierarchy } from "./declaration";

package/dist/lib/models/reflections/kind.d.ts

@@ -1,6 +1,7 @@
 import type { EnumKeys } from "../../utils";
 /**
  * Defines the available reflection kinds.
+ * @category Reflections
  */
 export declare enum ReflectionKind {
     Project = 1,
@@ -24,11 +25,10 @@ export declare enum ReflectionKind {
     Accessor = 262144,
     GetSignature = 524288,
     SetSignature = 1048576,
-    /** @deprecated will be removed in v0.25, not used */
-    ObjectLiteral = 2097152,
-    TypeAlias = 4194304,
-    Reference = 8388608
+    TypeAlias = 2097152,
+    Reference = 4194304
 }
+/** @category Reflections */
 export declare namespace ReflectionKind {
     type KindString = EnumKeys<typeof ReflectionKind>;
     const All: number;

package/dist/lib/models/reflections/kind.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReflectionKind = void 0;
 /**
  * Defines the available reflection kinds.
+ * @category Reflections
  */
 var ReflectionKind;
 (function (ReflectionKind) {
@@ -27,11 +28,10 @@ var ReflectionKind;
     ReflectionKind[ReflectionKind["Accessor"] = 262144] = "Accessor";
     ReflectionKind[ReflectionKind["GetSignature"] = 524288] = "GetSignature";
     ReflectionKind[ReflectionKind["SetSignature"] = 1048576] = "SetSignature";
-    /** @deprecated will be removed in v0.25, not used */
-    ReflectionKind[ReflectionKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
-    ReflectionKind[ReflectionKind["TypeAlias"] = 4194304] = "TypeAlias";
-    ReflectionKind[ReflectionKind["Reference"] = 8388608] = "Reference";
+    ReflectionKind[ReflectionKind["TypeAlias"] = 2097152] = "TypeAlias";
+    ReflectionKind[ReflectionKind["Reference"] = 4194304] = "Reference";
 })(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
+/** @category Reflections */
 (function (ReflectionKind) {
     ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
     /** @internal */
@@ -59,9 +59,7 @@ var ReflectionKind;
         ReflectionKind.TypeParameter |
         ReflectionKind.TypeAlias;
     /** @internal */
-    ReflectionKind.SomeValue = ReflectionKind.Variable |
-        ReflectionKind.Function |
-        ReflectionKind.ObjectLiteral;
+    ReflectionKind.SomeValue = ReflectionKind.Variable | ReflectionKind.Function;
     /** @internal */
     ReflectionKind.SomeMember = ReflectionKind.EnumMember |
         ReflectionKind.Property |

package/dist/lib/models/reflections/parameter.d.ts

@@ -2,6 +2,9 @@ import type { SomeType } from "..";
 import { Reflection, TraverseCallback } from "./abstract";
 import type { SignatureReflection } from "./signature";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
+/**
+ * @category Reflections
+ */
 export declare class ParameterReflection extends Reflection {
     readonly variant = "param";
     parent?: SignatureReflection;

package/dist/lib/models/reflections/parameter.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParameterReflection = void 0;
 const types_1 = require("../types");
 const abstract_1 = require("./abstract");
+/**
+ * @category Reflections
+ */
 class ParameterReflection extends abstract_1.Reflection {
     constructor() {
         super(...arguments);

package/dist/lib/models/reflections/project.d.ts

@@ -11,6 +11,7 @@ import type { Deserializer, JSONOutput } from "../../serialization/index";
  *
  * The project reflection acts as a global index, one may receive all reflections
  * and source files of the processed project through this reflection.
+ * @category Reflections
  */
 export declare class ProjectReflection extends ContainerReflection {
     readonly variant = "project";

package/dist/lib/models/reflections/project.js

@@ -15,6 +15,7 @@ const map_1 = require("../../utils/map");
  *
  * The project reflection acts as a global index, one may receive all reflections
  * and source files of the processed project through this reflection.
+ * @category Reflections
  */
 class ProjectReflection extends container_1.ContainerReflection {
     constructor(name) {
@@ -195,7 +196,8 @@ class ProjectReflection extends container_1.ContainerReflection {
     getReferenceGraph() {
         if (!this.referenceGraph) {
             this.referenceGraph = new Map();
-            for (const ref of Object.values(this.reflections)) {
+            for (const id in this.reflections) {
+                const ref = this.reflections[id];
                 if (ref instanceof reference_1.ReferenceReflection) {
                     const target = ref.tryGetTargetReflection();
                     if (target) {

package/dist/lib/models/reflections/reference.d.ts

@@ -13,6 +13,7 @@ import type { Reflection } from "./abstract";
  * // of copying the reflection.
  * export { a };
  * ```
+ * @category Reflections
  */
 export declare class ReferenceReflection extends DeclarationReflection {
     readonly variant = "reference";

package/dist/lib/models/reflections/reference.js

@@ -15,6 +15,7 @@ const kind_1 = require("./kind");
  * // of copying the reflection.
  * export { a };
  * ```
+ * @category Reflections
  */
 class ReferenceReflection extends declaration_1.DeclarationReflection {
     /**

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

@@ -6,6 +6,9 @@ import type { DeclarationReflection } from "./declaration";
 import type { ReflectionKind } from "./kind";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
 import { SourceReference } from "../sources/file";
+/**
+ * @category Reflections
+ */
 export declare class SignatureReflection extends Reflection {
     readonly variant = "signature";
     constructor(name: string, kind: SignatureReflection["kind"], parent: DeclarationReflection);

package/dist/lib/models/reflections/signature.js

@@ -4,6 +4,9 @@ exports.SignatureReflection = void 0;
 const types_1 = require("../types");
 const abstract_1 = require("./abstract");
 const file_1 = require("../sources/file");
+/**
+ * @category Reflections
+ */
 class SignatureReflection extends abstract_1.Reflection {
     constructor(name, kind, parent) {
         super(name, kind, parent);

package/dist/lib/models/reflections/type-parameter.d.ts

@@ -13,6 +13,9 @@ export declare const VarianceModifier: {
     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;

package/dist/lib/models/reflections/type-parameter.js

@@ -12,6 +12,9 @@ exports.VarianceModifier = {
     out: "out",
     inOut: "in out",
 };
+/**
+ * @category Reflections
+ */
 class TypeParameterReflection extends abstract_1.Reflection {
     constructor(name, parent, varianceModifier) {
         super(name, kind_1.ReflectionKind.TypeParameter, parent);

package/dist/lib/models/sources/file.d.ts

@@ -12,6 +12,7 @@ export declare class SourceReference {
     fileName: string;
     /**
      * The absolute filename of the source file.
+     * @internal
      */
     fullFileName: string;
     /**
@@ -27,6 +28,7 @@ export declare class SourceReference {
      */
     url?: string;
     constructor(fileName: string, line: number, character: number);
+    equals(other: SourceReference): boolean;
     toObject(): JSONSourceReference;
     fromObject(_de: Deserializer, obj: JSONSourceReference): void;
 }

package/dist/lib/models/sources/file.js

@@ -13,6 +13,11 @@ class SourceReference {
         this.line = line;
         this.character = character;
     }
+    equals(other) {
+        return (this.fullFileName == other.fullFileName &&
+            this.line === other.line &&
+            this.character === other.character);
+    }
     toObject() {
         return {
             fileName: this.fileName,

package/dist/lib/models/types.d.ts

@@ -8,6 +8,7 @@ import { ReflectionSymbolId } from "./reflections/ReflectionSymbolId";
 import type { DeclarationReference } from "../converter/comments/declarationReference";
 /**
  * Base class of all type definitions.
+ * @category Types
  */
 export declare abstract class Type {
     /**
@@ -33,6 +34,7 @@ export declare abstract class Type {
      */
     protected abstract getTypeString(): string;
 }
+/** @category Types */
 export interface TypeKindMap {
     array: ArrayType;
     conditional: ConditionalType;
@@ -59,7 +61,9 @@ export type TypeVisitor<T = void> = {
     [K in TypeKind]: (type: TypeKindMap[K]) => T;
 };
 export declare function makeRecursiveVisitor(visitor: Partial<TypeVisitor>): TypeVisitor;
+/** @category Types */
 export type TypeKind = keyof TypeKindMap;
+/** @category Types */
 export type SomeType = TypeKindMap[keyof TypeKindMap];
 /**
  * Enumeration that can be used when traversing types to track the location of recursion.
@@ -98,6 +102,7 @@ export type TypeContext = (typeof TypeContext)[keyof typeof TypeContext];
  * ```ts
  * let value: string[];
  * ```
+ * @category Types
  */
 export declare class ArrayType extends Type {
     elementType: SomeType;
@@ -116,6 +121,7 @@ export declare class ArrayType extends Type {
  * ```ts
  * let value: Check extends Extends ? True : False;
  * ```
+ * @category Types
  */
 export declare class ConditionalType extends Type {
     checkType: SomeType;
@@ -130,6 +136,7 @@ export declare class ConditionalType extends Type {
 }
 /**
  * Represents an indexed access type.
+ * @category Types
  */
 export declare class IndexedAccessType extends Type {
     objectType: SomeType;
@@ -146,6 +153,7 @@ export declare class IndexedAccessType extends Type {
  * ```ts
  * type Z = Promise<string> extends Promise<infer U> : never
  * ```
+ * @category Types
  */
 export declare class InferredType extends Type {
     name: string;
@@ -162,6 +170,7 @@ export declare class InferredType extends Type {
  * ```ts
  * let value: A & B;
  * ```
+ * @category Types
  */
 export declare class IntersectionType extends Type {
     types: SomeType[];
@@ -177,6 +186,7 @@ export declare class IntersectionType extends Type {
  * ```ts
  * let value: number;
  * ```
+ * @category Types
  */
 export declare class IntrinsicType extends Type {
     name: string;
@@ -193,6 +203,7 @@ export declare class IntrinsicType extends Type {
  * type A = "A"
  * type B = 1
  * ```
+ * @category Types
  */
 export declare class LiteralType extends Type {
     value: string | number | boolean | null | bigint;
@@ -211,6 +222,7 @@ export declare class LiteralType extends Type {
  * ```ts
  * { -readonly [K in Parameter as Name]?: Template }
  * ```
+ * @category Types
  */
 export declare class MappedType extends Type {
     parameter: string;
@@ -231,6 +243,7 @@ export declare class MappedType extends Type {
  * type Z = [1, 2?]
  * //           ^^
  * ```
+ * @category Types
  */
 export declare class OptionalType extends Type {
     elementType: SomeType;
@@ -247,6 +260,7 @@ export declare class OptionalType extends Type {
  * function isString(x: unknown): x is string {}
  * function assert(condition: boolean): asserts condition {}
  * ```
+ * @category Types
  */
 export declare class PredicateType extends Type {
     name: string;
@@ -277,6 +291,7 @@ export declare class PredicateType extends Type {
  * const x = 1
  * type Z = typeof x // query on reflection for x
  * ```
+ * @category Types
  */
 export declare class QueryType extends Type {
     queryType: ReferenceType;
@@ -298,6 +313,7 @@ export declare class QueryType extends Type {
  * ```ts
  * let value: MyClass<T>;
  * ```
+ * @category Types
  */
 export declare class ReferenceType extends Type {
     readonly type = "reference";
@@ -375,6 +391,7 @@ export declare class ReferenceType extends Type {
  * ```ts
  * let value: { a: string, b: number };
  * ```
+ * @category Types
  */
 export declare class ReflectionType extends Type {
     declaration: DeclarationReflection;
@@ -390,6 +407,7 @@ export declare class ReflectionType extends Type {
  * type Z = [1, ...2[]]
  * //           ^^^^^^
  * ```
+ * @category Types
  */
 export declare class RestType extends Type {
     elementType: SomeType;
@@ -404,6 +422,7 @@ export declare class RestType extends Type {
  * ```ts
  * type Z = `${'a' | 'b'}${'a' | 'b'}`
  * ```
+ * @category Types
  */
 export declare class TemplateLiteralType extends Type {
     head: string;
@@ -420,6 +439,7 @@ export declare class TemplateLiteralType extends Type {
  * ```ts
  * let value: [string, boolean];
  * ```
+ * @category Types
  */
 export declare class TupleType extends Type {
     elements: SomeType[];
@@ -438,6 +458,7 @@ export declare class TupleType extends Type {
  * ```ts
  * let value: [name: string];
  * ```
+ * @category Types
  */
 export declare class NamedTupleMember extends Type {
     name: string;
@@ -459,6 +480,7 @@ export declare class NamedTupleMember extends Type {
  * class A {}
  * class B<T extends keyof A> {}
  * ```
+ * @category Types
  */
 export declare class TypeOperatorType extends Type {
     target: SomeType;
@@ -475,6 +497,7 @@ export declare class TypeOperatorType extends Type {
  * ```ts
  * let value: string | string[];
  * ```
+ * @category Types
  */
 export declare class UnionType extends Type {
     types: SomeType[];
@@ -487,6 +510,7 @@ export declare class UnionType extends Type {
 }
 /**
  * Represents all unknown types that cannot be converted by TypeDoc.
+ * @category Types
  */
 export declare class UnknownType extends Type {
     readonly type = "unknown";

package/dist/lib/models/types.js

@@ -30,6 +30,7 @@ const ReflectionSymbolId_1 = require("./reflections/ReflectionSymbolId");
 const fs_1 = require("../utils/fs");
 /**
  * Base class of all type definitions.
+ * @category Types
  */
 class Type {
     /**
@@ -179,6 +180,7 @@ exports.TypeContext = {
  * ```ts
  * let value: string[];
  * ```
+ * @category Types
  */
 class ArrayType extends Type {
     /**
@@ -209,6 +211,7 @@ exports.ArrayType = ArrayType;
  * ```ts
  * let value: Check extends Extends ? True : False;
  * ```
+ * @category Types
  */
 class ConditionalType extends Type {
     constructor(checkType, extendsType, trueType, falseType) {
@@ -271,6 +274,7 @@ class ConditionalType extends Type {
 exports.ConditionalType = ConditionalType;
 /**
  * Represents an indexed access type.
+ * @category Types
  */
 class IndexedAccessType extends Type {
     constructor(objectType, indexType) {
@@ -305,6 +309,7 @@ exports.IndexedAccessType = IndexedAccessType;
  * ```ts
  * type Z = Promise<string> extends Promise<infer U> : never
  * ```
+ * @category Types
  */
 class InferredType extends Type {
     constructor(name, constraint) {
@@ -362,6 +367,7 @@ exports.InferredType = InferredType;
  * ```ts
  * let value: A & B;
  * ```
+ * @category Types
  */
 class IntersectionType extends Type {
     constructor(types) {
@@ -416,6 +422,7 @@ exports.IntersectionType = IntersectionType;
  * ```ts
  * let value: number;
  * ```
+ * @category Types
  */
 class IntrinsicType extends Type {
     constructor(name) {
@@ -444,6 +451,7 @@ exports.IntrinsicType = IntrinsicType;
  * type A = "A"
  * type B = 1
  * ```
+ * @category Types
  */
 class LiteralType extends Type {
     constructor(value) {
@@ -486,6 +494,7 @@ exports.LiteralType = LiteralType;
  * ```ts
  * { -readonly [K in Parameter as Name]?: Template }
  * ```
+ * @category Types
  */
 class MappedType extends Type {
     constructor(parameter, parameterType, templateType, readonlyModifier, optionalModifier, nameType) {
@@ -545,6 +554,7 @@ exports.MappedType = MappedType;
  * type Z = [1, 2?]
  * //           ^^
  * ```
+ * @category Types
  */
 class OptionalType extends Type {
     constructor(elementType) {
@@ -573,6 +583,7 @@ exports.OptionalType = OptionalType;
  * function isString(x: unknown): x is string {}
  * function assert(condition: boolean): asserts condition {}
  * ```
+ * @category Types
  */
 class PredicateType extends Type {
     /**
@@ -621,6 +632,7 @@ exports.PredicateType = PredicateType;
  * const x = 1
  * type Z = typeof x // query on reflection for x
  * ```
+ * @category Types
  */
 class QueryType extends Type {
     constructor(queryType) {
@@ -654,6 +666,7 @@ exports.QueryType = QueryType;
  * ```ts
  * let value: MyClass<T>;
  * ```
+ * @category Types
  */
 class ReferenceType extends Type {
     /**
@@ -829,6 +842,7 @@ exports.ReferenceType = ReferenceType;
  * ```ts
  * let value: { a: string, b: number };
  * ```
+ * @category Types
  */
 class ReflectionType extends Type {
     constructor(declaration) {
@@ -864,6 +878,7 @@ exports.ReflectionType = ReflectionType;
  * type Z = [1, ...2[]]
  * //           ^^^^^^
  * ```
+ * @category Types
  */
 class RestType extends Type {
     constructor(elementType) {
@@ -890,6 +905,7 @@ exports.RestType = RestType;
  * ```ts
  * type Z = `${'a' | 'b'}${'a' | 'b'}`
  * ```
+ * @category Types
  */
 class TemplateLiteralType extends Type {
     constructor(head, tail) {
@@ -932,6 +948,7 @@ exports.TemplateLiteralType = TemplateLiteralType;
  * ```ts
  * let value: [string, boolean];
  * ```
+ * @category Types
  */
 class TupleType extends Type {
     /**
@@ -966,6 +983,7 @@ exports.TupleType = TupleType;
  * ```ts
  * let value: [name: string];
  * ```
+ * @category Types
  */
 class NamedTupleMember extends Type {
     constructor(name, isOptional, element) {
@@ -1001,6 +1019,7 @@ exports.NamedTupleMember = NamedTupleMember;
  * class A {}
  * class B<T extends keyof A> {}
  * ```
+ * @category Types
  */
 class TypeOperatorType extends Type {
     constructor(target, operator) {
@@ -1055,6 +1074,7 @@ exports.TypeOperatorType = TypeOperatorType;
  * ```ts
  * let value: string | string[];
  * ```
+ * @category Types
  */
 class UnionType extends Type {
     constructor(types) {
@@ -1125,6 +1145,7 @@ class UnionType extends Type {
 exports.UnionType = UnionType;
 /**
  * Represents all unknown types that cannot be converted by TypeDoc.
+ * @category Types
  */
 class UnknownType extends Type {
     constructor(name) {

package/dist/lib/output/components.d.ts

@@ -32,6 +32,7 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
      * @param renderer  The renderer this plugin should be attached to.
      */
     protected initialize(): void;
+    private absoluteToRelativePathMap;
     /**
      * Transform the given absolute path into a relative path.
      *