typedoc 0.26.10 → 0.27.0-beta.0

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

@@ -1,12 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SourceReference = void 0;
 /**
  * Represents references of reflections to their defining source files.
  *
  * @see {@link DeclarationReflection.sources}
  */
-class SourceReference {
+export class SourceReference {
+    /**
+     * The filename of the source file.
+     */
+    fileName;
+    /**
+     * The absolute filename of the source file.
+     * @internal
+     */
+    fullFileName;
+    /**
+     * The one based number of the line that emitted the declaration.
+     */
+    line;
+    /**
+     * The index of the character that emitted the declaration.
+     */
+    character;
+    /**
+     * URL for displaying the source file.
+     */
+    url;
     constructor(fileName, line, character) {
         this.fileName = fileName;
         this.fullFileName = fileName;
@@ -30,4 +48,3 @@ class SourceReference {
         this.url = obj.url;
     }
 }
-exports.SourceReference = SourceReference;

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

@@ -1 +1 @@
-export { SourceReference } from "./file";
+export { SourceReference } from "./file.js";

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

@@ -1,5 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SourceReference = void 0;
-var file_1 = require("./file");
-Object.defineProperty(exports, "SourceReference", { enumerable: true, get: function () { return file_1.SourceReference; } });
+export { SourceReference } from "./file.js";

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

@@ -1,12 +1,12 @@
 import * as ts from "typescript";
-import type { Context } from "../converter";
-import type { Reflection } from "./reflections/abstract";
-import type { DeclarationReflection } from "./reflections/declaration";
-import type { ProjectReflection } from "./reflections/project";
-import type { Serializer, JSONOutput, Deserializer } from "../serialization";
-import { ReflectionSymbolId } from "./reflections/ReflectionSymbolId";
-import type { DeclarationReference } from "../converter/comments/declarationReference";
-import { type CommentDisplayPart } from "./comments";
+import type { Context } from "../converter/index.js";
+import type { Reflection } from "./reflections/abstract.js";
+import type { DeclarationReflection } from "./reflections/declaration.js";
+import type { ProjectReflection } from "./reflections/project.js";
+import type { Serializer, JSONOutput, Deserializer } from "../serialization/index.js";
+import { ReflectionSymbolId } from "./reflections/ReflectionSymbolId.js";
+import type { DeclarationReference } from "../converter/comments/declarationReference.js";
+import { type CommentDisplayPart } from "./comments/index.js";
 /**
  * Base class of all type definitions.
  * @category Types
@@ -23,8 +23,8 @@ export declare abstract class Type {
     /**
      * Visit this type, returning the value returned by the visitor.
      */
-    visit<T>(visitor: TypeVisitor<T>): T;
-    visit<T>(visitor: Partial<TypeVisitor<T>>): T | undefined;
+    visit<T, A extends any[] = []>(visitor: TypeVisitor<T, A>, ...args: A): T;
+    visit<T, A extends any[] = []>(visitor: Partial<TypeVisitor<T, A>>, ...args: A): T | undefined;
     stringify(context: TypeContext): string;
     abstract toObject(serializer: Serializer): JSONOutput.SomeType;
     fromObject(_de: Deserializer, _obj: JSONOutput.SomeType): void;
@@ -34,6 +34,10 @@ export declare abstract class Type {
      * the returned string should be wrapped in parenthesis.
      */
     protected abstract getTypeString(): string;
+    /**
+     * Return the estimated size of the type if it was all printed on one line.
+     */
+    estimatePrintWidth(): number;
 }
 /** @category Types */
 export interface TypeKindMap {
@@ -58,8 +62,8 @@ export interface TypeKindMap {
     union: UnionType;
     unknown: UnknownType;
 }
-export type TypeVisitor<T = void> = {
-    [K in TypeKind]: (type: TypeKindMap[K]) => T;
+export type TypeVisitor<T = void, A extends any[] = []> = {
+    [K in TypeKind]: (type: TypeKindMap[K], ...args: A) => T;
 };
 export declare function makeRecursiveVisitor(visitor: Partial<TypeVisitor>): TypeVisitor;
 /** @category Types */
@@ -333,6 +337,15 @@ export declare class ReferenceType extends Type {
      * The resolved reflection.
      */
     get reflection(): Reflection | undefined;
+    /**
+     * Sometimes a few properties are more important than the rest
+     * of the properties within a type. This occurs most often with
+     * object parameters, where users want to specify `@param foo.bar`
+     * to highlight something about the `bar` property.
+     *
+     * Does NOT support nested properties.
+     */
+    highlightedProperties?: Map<string, CommentDisplayPart[]>;
     /**
      * If not resolved, the symbol id of the reflection, otherwise undefined.
      */
@@ -403,7 +416,7 @@ export declare class ReflectionType extends Type {
     declaration: DeclarationReflection;
     readonly type = "reflection";
     constructor(declaration: DeclarationReflection);
-    protected getTypeString(): "Function" | "Object";
+    protected getTypeString(): string;
     needsParenthesis(): boolean;
     toObject(serializer: Serializer): JSONOutput.ReflectionType;
 }