v0.28.3

Compare Source

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

Compare Source

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 ofexternalSymbolLinkMappings 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

Compare Source

Features

• TheTypeDocOptions interface now marks options as optional so it no longer has to be wrapped inPartial
  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 oflocalStorage without clearing it,#​2908.

Bug Fixes

• --watch can now infer entry points frompackage.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 convertingmodule.exports = [],#​2909.
• Fixed URL generation which introduced a superfluous./ in relative links,#​2910.

Thanks!

• @​jsmith2-coveo
• @​romainmnr

v0.28.0

Compare Source

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.
• Removedjp translations fromlang, to migrate switch toja.
• File name references inintentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
• Thesource-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 discoveredpackage.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 andProjectReflection.getSymbolFromReflection have been moved toContext
• Path andPathArray parameter types now always contain normalized paths.
• Introduced aRouter which is used for URL creation.Reflection.url,
  Reflection.anchor, andReflection.hasOwnDocument have been removed.
• Deserializer.reviveProject(s) no longer accepts an option to add project documents.
• Deserializer.reviveProjects now requires analwaysCreateEntryPointModule 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.
  ThefileName property will be present when initially created, but is not serialized.
• RemovedDeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
• i18n proxy is no longer passed to many functions, instead, referencei18n exported from the module directly.
• ReflectionKind.singularString andReflectionKind.pluralString now returns translated strings.
  The methods onInternationalization to do this previously have been removed.
• The HTML output structure for the search box has changed to support the new modal.
• DefaultThemeRenderContext'stypeDeclaration andtypeDetailsIfUseful
  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
• IntroducedpackagesRequiringDocumentation option forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
• TypeDoc now exports atypedoc/browser entrypoint for parsing and using serialized JSON files,#​2528.
• TypepackageOptions asPartial<TypeDocOptions>,#​2878.
• TypeDoc will now warn if an option which should only be set at the root level is set inpackageOptions,#​2878.
• Introduced@function tag to force TypeDoc to convert variable declarations with a type annotation as functions,#​2881.
• Exposed aTypeDoc global object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage,#​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: IntroducedDefaultThemeRenderContext.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

Compare Source

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

Compare Source

Features

• ThevisibilityFilter option now supports individual signatures,#​2846.
• Thefavicon option may now be given a link starting withhttps?:// instead of a path,#​2851.
• TypeDoc now supports specifying# as the link inexternalSymbolLinkMappings 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 toundefined,#​2854.

Thanks!

• @​pjeby
• @​XeroAlpha

v0.27.7

Compare Source

Features

• @includeCode and@inline can now inject parts of files using region
  names or line numbers,#​2816.
• Introducedja translation options, deprecatedjp in favor ofja,#​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

v0.27.6

Compare Source

Features

• AddedignoredHighlightLanguages option to specify languages which will be
  allowed in code blocks but not highlighted,#​2819.

Bug Fixes

• @include and@includeCode now work in the readme file,#​2814.
• TypeDoc will now avoid making references to references,#​2811.
• Fixed output specific option specification,#​2818.
• Improved type reference conversion to avoid including defaulted type arguments,#​2820.
• Fixed parsing of declaration references which include a module and a local reference,#​2810.
• Improved link resolution logic to prioritize type alias properties with the
  same symbol over type literal properties within function parameters.

v0.27.5

Compare Source

Bug Fixes

• Possibly Breaking: TypeDoc will no longer render anchors within the page for
  deeply nested properties. This only affects links to properties of
  properties of types, which did not have a clickable link exposed so are
  unlikely to have been linked to. Furthermore, these links were not always
  created by TypeDoc, only being created if all parent properties contained
  comments,#​2808.
• TypeDoc will now warn if a property which does not have a URL within the
  rendered document and the parent property/page will be linked to instead,
  #​2808. These warnings can be disabled with thevalidation.rewrittenLink
  option.
• Fix restoration of groups/categories including documents,#​2801.
• Fixed missed relative paths within markdown link references in documents.
• Improved handling of incomplete inline code blocks within markdown.
• Directhttps:// links under thehostedBaseUrl option's URL will no
  longer be treated as external,#​2809.

Thanks!

• @​SacDeNoeuds

v0.27.4

Compare Source

Features

• API: Introduced newConverter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter,#​2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems,#​2796.
• @include and@includeCode now work for comments on the entry point for projects with a single entry point,#​2800.
• Cascaded modifier tags will no longer be copied into type literals,#​2802.
• @summary now works to describe functions within modules,#​2803.
• Corrected navigation showing module link as current when not on module page,#​2805.

v0.27.3

Compare Source

Features

• Added support for PNG favicons,#​2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules,#​2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error,#​2792.
• Fixed low contrast in default colors for properties/accessors in light mode,#​2795.
• ThehighlightLanguages option now permits Shiki aliases to be specified rather than just the language ID,#​2798.

Thanks!

• @​mikalai-snap
• @​mistic100