Typedoc Versions Save

Features

• Added gitRevision:short placeholder option to --sourceLinkTemplate option, #2529. Links generated by TypeDoc will now default to using the non-short git revision.
• Moved "Generated by TypeDoc" footer into a <footer> tag, added footer.begin and footer.end render hooks for use by custom plugins, #2532.

Bug Fixes

• Fixed conversion of NoInfer missing type parameter reference, #2539.
• Linking to a member on a page no longer incorrectly claims that "This member is normally hidden due to your filter settings" for every member.

Thanks!

• @xuhdev

Features

• Added support for TypeScript 5.4, #2517.

Bug Fixes

• Updated page font to work around issues with Mac rendering, #2518.

Thanks!

• @docmattman

Bug Fixes

• Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
• "On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #2515.

Bug Fixes

• Constructed references to enum types will be properly linked with @interface, #2508.
• Comments on property-methods will no longer be duplicated in generated documentation, #2509.
• Reduced rendered docs size by writing icons to a referenced SVG asset, #2505. For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
• The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
• When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.

Features

• Literal numeric unions will now be sorted during conversion, #2502.

Bug Fixes

• Module readmes will now be included in JSON output, #2500.
• Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #2496.
• Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #2507.
• Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

Thanks!

• @JMBeresford

Features

• Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
• Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479. Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
• Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
• API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

• Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
• A class which implements itself will no longer cause a crash when rendering HTML, #2495.
• Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
• The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
• Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
• API: Context.programs will no longer contain duplicates, #2498.

Bug Fixes

• Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
• Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.

Bug Fixes

• Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
• Improved infinite loop detection in type converter to reduce false positives.

Features

• Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
• Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
• Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
• TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
• Extended reflection preview view for interfaces to include type parameters, #2455.
• Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458. Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this as the compiler strips that information when creating types for a class instance.
• Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via Object.assign or via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.

Bug Fixes

• If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
• notDocumented validation will no longer require documentation for data within parameters that cannot be documented via @param, #2291.
• "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
• Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
• TypeDoc now inherits typedocOptions fields from extended tsconfig files, #2334.
• Methods which return function types no longer have duplicated comments, #2336.
• Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
• Improved detection of default values for parameters with destructured values, #2430.
• Fix crash when converting some complicated union/intersection types, #2451.
• Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
• @group and @category organization is now applied later to allow inherited comments to create groups/categories, #2459.
• Conversion order should no longer affect link resolution for classes with properties whose type does not rely on this, #2466.
• Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
• Module reflections now have a custom M icon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.
• If all members in a group are hidden from the page, the group will be hidden in the page index on page load.

Features

• Added support for TypeScript 5.3, #2446.
• TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449. This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
• Improved type rendering to highlight keywords differently than symbols.

Bug Fixes

• Fixed automatic declaration file resolution on Windows, #2416.
• Fixed default option values on options declared by plugins in packages mode, #2433.
• gitRevision will now be replaced in sourceLinkTemplate, #2434.
• Improved handling of function-modules created with Object.assign, #2436.
• TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
• Fixed an infinite loop when skipLibCheck is used to ignore some compiler errors, #2438.
• @example tag titles will now be rendered in the example heading, #2440.
• Correctly handle transient symbols in @namespace-created namespaces, #2444.
• TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
• Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.

Thanks!

• @li-jia-nan
• @Nokel81
• @ocavue
• @swarnpallav