typedoc 0.25.0 → 0.25.2

package/dist/lib/converter/factories/signature.d.ts

@@ -5,3 +5,4 @@ export declare function createSignature(context: Context, kind: ReflectionKind.C
 export declare function convertParameterNodes(context: Context, sigRef: SignatureReflection, parameters: readonly (ts.JSDocParameterTag | ts.ParameterDeclaration)[]): ParameterReflection[];
 export declare function convertTypeParameterNodes(context: Context, parameters: readonly ts.TypeParameterDeclaration[] | undefined): TypeParameterReflection[] | undefined;
 export declare function createTypeParamReflection(param: ts.TypeParameterDeclaration, context: Context): TypeParameterReflection;
+export declare function convertTemplateParameterNodes(context: Context, nodes: readonly ts.JSDocTemplateTag[] | undefined): TypeParameterReflection[] | undefined;

package/dist/lib/converter/factories/signature.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTypeParamReflection = exports.convertTypeParameterNodes = exports.convertParameterNodes = exports.createSignature = void 0;
+exports.convertTemplateParameterNodes = exports.createTypeParamReflection = exports.convertTypeParameterNodes = exports.convertParameterNodes = exports.createSignature = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 const assert_1 = __importDefault(require("assert"));
 const models_1 = require("../../models");
@@ -12,9 +12,8 @@ const convert_expression_1 = require("../convert-expression");
 const reflections_1 = require("../utils/reflections");
 const ReflectionSymbolId_1 = require("../../models/reflections/ReflectionSymbolId");
 function createSignature(context, kind, signature, symbol, declaration) {
-    var _a;
     (0, assert_1.default)(context.scope instanceof models_1.DeclarationReflection);
-    declaration || (declaration = signature.getDeclaration());
+    declaration ||= signature.getDeclaration();
     const sigRef = new models_1.SignatureReflection(kind == models_1.ReflectionKind.ConstructorSignature
         ? `new ${context.scope.parent.name}`
         : context.scope.name, kind, context.scope);
@@ -63,7 +62,7 @@ function createSignature(context, kind, signature, symbol, declaration) {
             break;
         case models_1.ReflectionKind.CallSignature:
         case models_1.ReflectionKind.ConstructorSignature:
-            (_a = context.scope).signatures ?? (_a.signatures = []);
+            context.scope.signatures ??= [];
             context.scope.signatures.push(sigRef);
             break;
     }
@@ -80,7 +79,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
         if (declaration && typescript_1.default.isJSDocParameterTag(declaration)) {
             paramRefl.comment = context.getJsDocComment(declaration);
         }
-        paramRefl.comment || (paramRefl.comment = context.getComment(param, paramRefl.kind));
+        paramRefl.comment ||= context.getComment(param, paramRefl.kind);
         context.registerReflection(paramRefl, param);
         context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
         let type;
@@ -196,6 +195,33 @@ function createTypeParamReflection(param, context) {
     return paramRefl;
 }
 exports.createTypeParamReflection = createTypeParamReflection;
+function convertTemplateParameterNodes(context, nodes) {
+    return nodes?.flatMap((node) => {
+        return node.typeParameters.map((param, index) => {
+            const paramRefl = new models_1.TypeParameterReflection(param.name.text, context.scope, getVariance(param.modifiers));
+            const paramScope = context.withScope(paramRefl);
+            paramRefl.type =
+                index || !node.constraint
+                    ? void 0
+                    : context.converter.convertType(paramScope, node.constraint.type);
+            paramRefl.default = param.default
+                ? context.converter.convertType(paramScope, param.default)
+                : void 0;
+            if (param.modifiers?.some((m) => m.kind === typescript_1.default.SyntaxKind.ConstKeyword)) {
+                paramRefl.flags.setFlag(models_1.ReflectionFlag.Const, true);
+            }
+            context.registerReflection(paramRefl, param.symbol);
+            if (typescript_1.default.isJSDocTemplateTag(param.parent)) {
+                paramRefl.comment = context.getJsDocComment(param.parent);
+            }
+            context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl, param);
+            return paramRefl;
+        });
+    });
+    const params = (nodes ?? []).flatMap((tag) => tag.typeParameters);
+    return convertTypeParameterNodes(context, params);
+}
+exports.convertTemplateParameterNodes = convertTemplateParameterNodes;
 function getVariance(modifiers) {
     const hasIn = modifiers?.some((mod) => mod.kind === typescript_1.default.SyntaxKind.InKeyword);
     const hasOut = modifiers?.some((mod) => mod.kind === typescript_1.default.SyntaxKind.OutKeyword);

package/dist/lib/converter/jsdoc.js

@@ -70,16 +70,12 @@ function convertJsDocSignature(context, node) {
     reflection.signatures = [signature];
     signature.type = context.converter.convertType(signatureCtx, node.type?.typeExpression?.type);
     signature.parameters = (0, signature_1.convertParameterNodes)(signatureCtx, signature, node.parameters);
-    signature.typeParameters = convertTemplateParameterNodes(context.withScope(reflection), node.typeParameters);
+    signature.typeParameters = (0, signature_1.convertTemplateParameterNodes)(context.withScope(reflection), node.typeParameters);
     return new models_1.ReflectionType(reflection);
 }
 function convertTemplateParameters(context, node) {
     (0, assert_1.ok)(context.scope instanceof models_1.DeclarationReflection);
-    context.scope.typeParameters = convertTemplateParameterNodes(context, node.tags?.filter(typescript_1.default.isJSDocTemplateTag));
-}
-function convertTemplateParameterNodes(context, nodes) {
-    const params = (nodes ?? []).flatMap((tag) => tag.typeParameters);
-    return (0, signature_1.convertTypeParameterNodes)(context, params);
+    context.scope.typeParameters = (0, signature_1.convertTemplateParameterNodes)(context, node.tags?.filter(typescript_1.default.isJSDocTemplateTag));
 }
 function getTypedefReExportTarget(context, declaration) {
     const typeExpression = declaration.typeExpression;

package/dist/lib/converter/plugins/CategoryPlugin.d.ts

@@ -1,5 +1,4 @@
 import { DeclarationReflection } from "../../models";
-import { ReflectionCategory } from "../../models";
 import { ConverterComponent } from "../components";
 /**
  * A handler that sorts and categorizes the found reflections in the resolving phase.
@@ -8,10 +7,10 @@ import { ConverterComponent } from "../components";
  */
 export declare class CategoryPlugin extends ConverterComponent {
     sortFunction: (reflections: DeclarationReflection[]) => void;
-    defaultCategory: string;
-    categoryOrder: string[];
-    categorizeByGroup: boolean;
-    boosts: Record<string, number>;
+    accessor defaultCategory: string;
+    accessor categoryOrder: string[];
+    accessor categorizeByGroup: boolean;
+    accessor boosts: Record<string, number>;
     usedBoosts: Set<string>;
     static defaultCategory: string;
     static WEIGHTS: string[];
@@ -47,7 +46,7 @@ export declare class CategoryPlugin extends ConverterComponent {
      *   relevance boost to be used when searching
      * @returns An array containing all children of the given reflection categorized
      */
-    getReflectionCategories(reflections: DeclarationReflection[]): ReflectionCategory[];
+    private getReflectionCategories;
     /**
      * Return the category of a given reflection.
      *
@@ -57,7 +56,7 @@ export declare class CategoryPlugin extends ConverterComponent {
      * @privateRemarks
      * If you change this, also update getGroups in GroupPlugin accordingly.
      */
-    getCategories(reflection: DeclarationReflection): Set<string>;
+    private extractCategories;
     /**
      * Callback used to sort categories by name.
      *
@@ -65,5 +64,6 @@ export declare class CategoryPlugin extends ConverterComponent {
      * @param b The right reflection to sort.
      * @returns The sorting weight.
      */
-    static sortCatCallback(a: ReflectionCategory, b: ReflectionCategory): number;
+    private static sortCatCallback;
+    static getCategories(reflection: DeclarationReflection): Set<string>;
 }