typedoc - npm Package Versions

v0.23.28 (2023-03-19)

Features

• Added support for TypeScript 5.0, #2201.
  • const type parameters.
  • JSDoc @overload tag.
  • JSDoc @satisfies tag.

v0.23.27 (2023-03-16)

Features

• Added --treatValidationWarningsAsErrors to treat only validation warnings as errors without treating all warnings as errors, #2199.

Bug Fixes

• Fixed a bug where optional properties were not appropriately marked as optional, #2200.
• Fixed shifted navigation pane on devices 1024px wide, #2191.
• Add missing @private and @protected tags to typedoc/tsdoc.json, #2187.

Thanks!

• @futurGH

v0.23.26 (2023-02-26)

Features

• Added Application.EVENT_VALIDATE_PROJECT event for plugins which implement custom validation, #2183.
• Plugins may now return an object from external symbol resolvers, #2066.
• Expose Comment.displayPartsToMarkdown on for themes overwriting the comment helper, #2115.

Bug Fixes

• Fix crash when converting export default undefined, #2175.
• Fix error in console when clicking on headings in the readme, #2170.
• TypeDoc will now ignore parameters of callback parameters when validating that all parameters have documentation, #2154.

Thanks!

• @captain-torch
• @loopingz
• @RebeccaStevens

v0.23.25 (2023-02-11)

Breaking Changes

• Upgraded Shiki, if your highlight theme was set to material-<theme>, the value will need to be changed to material-theme-<theme>, see the Shiki release notes.

Features

• Added new excludeNotDocumentedKinds variable to control which reflection types can be removed by the excludeNotDocumented option, #2162.
• Added typedoc.jsonc, typedoc.config.js, typedoc.config.cjs, typedoc.cjs to the list of files which TypeDoc will automatically use as configuration files.

Bug Fixes

• Entry points under node_modules will no longer be ignored, #2151.
• Corrected behavior of excludeNotDocumented on arrow function-variables, #2156.
• Added package.json to exports declaration.

Thanks!

• @boneskull
• @Mikkal24
• @zamiell

v0.23.24 (2023-01-07)

Bug Fixes

• Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
• Fixed symlink handling when expanding entry points, #2130.

Thanks!

• @boneskull

v0.23.23 (2022-12-18)

Features

• Added ts.Signature to emitted EVENT_CREATE_SIGNATURE event, #2002.

Bug Fixes

• Links to members hidden by filter settings now temporarily override the filter, #2092.
• If src/ and src/x are specified as entry points, src/ will no longer be ignored, #2121.

v0.23.22 (2022-12-11)

Features

• Add support for defining the kind sort order, #2109.

Bug Fixes

• Normalize all file paths on Windows, #2113.
• Fix @link tags within lists, #2103.