typedoc - npm Package Versions

v0.28.3 (2025-04-20)

Bug Fixes

• @inline now functions when referencing tuple types, #2932.
• @link links to the current page are now rendered, #2934.
• @includeCode now supports regions in TypeScript files with .mts and .cts file extensions, #2935.
• Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.
• Improved error reporting when paths including Windows separators are provided as globs, #2938.

v0.28.2 (2025-04-07)

Features

• @group none and @category none will now render their children without a section heading in the default theme, #2922.
• Added @disableGroups tag to completely disable the grouping mechanism for a given reflection, #2922.

Bug Fixes

• Variables using @class now correctly handle @category, #2914.
• Variables using @class now include constructor parameters, #2914.
• Variables using @class with a generic first constructor function now adopt that function's type parameters as the class type parameters, #2914.
• When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.
• Inlining types can now handle more type variants, #2920.
• Fixed behavior of externalSymbolLinkMappings option when URL is set to #, #2921.
• Fixed broken links within module pages when structure-dir router was used, #2928.
• Type parameters on JS classes defined with @typedef now correctly handle the constraint, #2929.
• API: toString on types containing index signatures now behave correctly, #2917.
• Added @inlineType to the list of tags excluded by default.

v0.28.1 (2025-03-20)

Features

• The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial for use in config files, #2901.
• API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
• API: Expose method to disable TypeDoc usage of localStorage without clearing it, #2908.

Bug Fixes

• --watch can now infer entry points from package.json as supported in non-watch mode, #2899.
• @include with regions now works on files with CRLF line endings, #2902.
• Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
• Fixed a crash when converting module.exports = [], #2909.
• Fixed URL generation which introduced a superfluous ./ in relative links, #2910.

Thanks!

• @jsmith2-coveo
• @romainmnr

v0.28.0 (2025-03-15)

Breaking Changes

• TypeDoc now expects all input globs paths to be specified with / path separators, #2825.
• TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.
• Removed jp translations from lang, to migrate switch to ja.
• File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
• The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.
• TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
• Function-like variable exports will now only be automatically converted as function types if they are initialized with a function expression. TypeDoc can be instructed to convert them as functions with the @function tag, #2881.
• Object literal type alias types will now be converted in a way which causes them to be rendered more similarly to how interfaces are rendered, #2817.

API Breaking Changes

• ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context
• Path and PathArray parameter types now always contain normalized paths.
• Introduced a Router which is used for URL creation. Reflection.url, Reflection.anchor, and Reflection.hasOwnDocument have been removed.
• Deserializer.reviveProject(s) no longer accepts an option to add project documents.
• Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.
• Comment.serializeDisplayParts no longer requires a serializer argument.
• ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead. The fileName property will be present when initially created, but is not serialized.
• Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
• i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
• ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings. The methods on Internationalization to do this previously have been removed.
• The HTML output structure for the search box has changed to support the new modal.
• DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful methods now require both a reflection and a type in order to support @expandType

Features

• Add support for TypeScript 5.8.x
• The search modal in the HTML output has been rewritten to provide better mobile support
• Added a --router option which can be used to modify TypeDoc's output folder structure. This can be extended with plugins, #2111.
• Introduced the @primaryExport modifier tag to provide more fine grained control over export conversion order, #2856
• Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
• TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.
• Type packageOptions as Partial<TypeDocOptions>, #2878.
• TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
• Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
• Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
• Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #2862.
• Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #2862.
• API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.

Bug Fixes

• TypeDoc will now only create references for symbols re-exported from modules.
• Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.
• User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
• Fixed handling of expando functions which were also merged with a namespace, #2876.
• Fixed rendering of function types within arrays and union types, #2892.
• Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.

Thanks!

• @crimx
• @jsmith2-coveo
• @phoneticallySAARTHaK
• @XeroAlpha

v0.27.9 (2025-02-25)

This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.

Features

• Added support for TypeScript 5.8

v0.27.8 (2025-02-21)

Features

• The visibilityFilter option now supports individual signatures, #2846.
• The favicon option may now be given a link starting with https?:// instead of a path, #2851.
• TypeDoc now supports specifying # as the link in externalSymbolLinkMappings to indicate the type should not be linked to, #2853.

Bug Fixes

• Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.
• Unresolved external type references will no longer incorrectly linked to undefined, #2854.

Thanks!

• @pjeby
• @XeroAlpha

v0.27.7 (2025-02-09)

Features

• @includeCode and @inline can now inject parts of files using region names or line numbers, #2816.
• Introduced ja translation options, deprecated jp in favor of ja, #2843.
• Improved TypeDoc's --watch option to support watching files not caught by TypeScript's watch mode, #2675.
• The @inline tag now works in more places for generic types.
• Visibility filters now consider individual signatures, #2846.

Bug Fixes

• Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
• Improved narrator support for labeling icons, #2832.
• Fixed an issue with @class incorrectly handling mapped types, #2842.
• TypeDoc will now consider symbols to be external only if all of their declarations are external so that declaration merged members with global symbols can be documented, #2844.
• Fixed an issue where TypeDoc would constantly rebuild, #2844.
• Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.

Thanks!

• @pjeby
• @shawninder
• @tats-u
• @XeroAlpha