typedoc 0.24.8 → 0.25.1

package/README.md

@@ -46,7 +46,7 @@ https://github.com/Gerrit0/typedoc-packages-example
 ### Arguments
 
 For a complete list of the command line arguments run `typedoc --help` or visit
-[our website](https://typedoc.org/guides/options/).
+[our website](https://typedoc.org/options/).
 
 -   `--out <path/to/documentation/>`<br>
     Specifies the location the documentation should be written to. Defaults to `./docs`

package/dist/index.d.ts

@@ -5,11 +5,15 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
  * All symbols documented under the Models namespace are also available in the root import.
  */
 export * as Models from "./lib/models";
+/**
+ * All symbols documented under the Configuration namespace are also available in the root import.
+ */
+export * as Configuration from "./lib/utils/options";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
-export type { RenderTemplate, RendererHooks } from "./lib/output";
-export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
+export type { RenderTemplate, RendererHooks, NavigationElement, } from "./lib/output";
+export { ArgumentsReader, Option, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
 export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, JsDocCompatibility, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";

package/dist/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -41,6 +41,10 @@ Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: fun
  * All symbols documented under the Models namespace are also available in the root import.
  */
 exports.Models = __importStar(require("./lib/models"));
+/**
+ * All symbols documented under the Configuration namespace are also available in the root import.
+ */
+exports.Configuration = __importStar(require("./lib/utils/options"));
 __exportStar(require("./lib/models"), exports);
 var converter_1 = require("./lib/converter");
 Object.defineProperty(exports, "Converter", { enumerable: true, get: function () { return converter_1.Converter; } });
@@ -57,6 +61,7 @@ Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: functio
 Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function () { return output_1.IndexEvent; } });
 var utils_1 = require("./lib/utils");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
+Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return utils_1.Option; } });
 Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return utils_1.BindOption; } });
 Object.defineProperty(exports, "CommentStyle", { enumerable: true, get: function () { return utils_1.CommentStyle; } });
 Object.defineProperty(exports, "JSX", { enumerable: true, get: function () { return utils_1.JSX; } });

package/dist/lib/application.d.ts

@@ -2,11 +2,12 @@ import { Converter } from "./converter/index";
 import { Renderer } from "./output/renderer";
 import { Deserializer, Serializer } from "./serialization";
 import type { ProjectReflection } from "./models/index";
-import { Logger } from "./utils/index";
+import { Logger, OptionsReader } from "./utils/index";
 import { AbstractComponent, ChildableComponent } from "./utils/component";
 import { Options } from "./utils";
 import type { TypeDocOptions } from "./utils/options/declaration";
 import { DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
+export declare function createAppForTesting(): Application;
 /**
  * The default TypeDoc main application class.
  *
@@ -43,11 +44,11 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     logger: Logger;
     options: Options;
     /** @internal */
-    readonly skipErrorChecking: boolean;
+    accessor skipErrorChecking: boolean;
     /** @internal */
-    readonly entryPointStrategy: EntryPointStrategy;
+    accessor entryPointStrategy: EntryPointStrategy;
     /** @internal */
-    readonly entryPoints: string[];
+    accessor entryPoints: string[];
     /**
      * The version number of TypeDoc.
      */
@@ -70,24 +71,25 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     /**
      * Create a new TypeDoc application instance.
      */
-    constructor();
+    private constructor();
     /**
      * Initialize TypeDoc, loading plugins if applicable.
      */
-    bootstrapWithPlugins(options?: Partial<TypeDocOptions>): Promise<void>;
+    static bootstrapWithPlugins(options?: Partial<TypeDocOptions>, readers?: readonly OptionsReader[]): Promise<Application>;
     /**
      * Initialize TypeDoc without loading plugins.
      *
      * @example
      * Initialize the application with pretty-printing output disabled.
      * ```ts
-     * const app = new Application();
-     * app.bootstrap({ pretty: false });
+     * const app = Application.bootstrap({ pretty: false });
      * ```
      *
-     * @param options - Options to set during initialization
+     * @param options Options to set during initialization
+     * @param readers Option readers to use to discover options from config files.
      */
-    bootstrap(options?: Partial<TypeDocOptions>): void;
+    static bootstrap(options?: Partial<TypeDocOptions>, readers?: readonly OptionsReader[]): Promise<Application>;
+    private _bootstrap;
     private setOptions;
     /**
      * Return the path to the TypeScript compiler.
@@ -104,7 +106,7 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      *
      * @returns An instance of ProjectReflection on success, undefined otherwise.
      */
-    convert(): ProjectReflection | undefined;
+    convert(): Promise<ProjectReflection | undefined>;
     convertAndWatch(success: (project: ProjectReflection) => Promise<void>): void;
     validate(project: ProjectReflection): void;
     /**