npm typedoc 0.22.5
v0.22.5

latest releases: 0.27.0-beta.0, 0.26.11, 0.26.10...
3 years ago

Features

  • TypeDoc will now recognize @param comments for destructured parameters and rename __namedParameters to the name specified
    in the @param comment if the number of @param comments match the number of parameters, resolves #1703.
  • The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following
    will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo
    declared in src/utils/foo.ts is not exported.
    {
        "intentionallyNotExported": ["src/foo.ts:Foo"]
    }
  • The --emit option can now be used to more finely control what TypeDoc will emit.
    Value Behavior
    both Emit both documentation and JS.
    docs Emit documentation, but not JS (default).
    none Emit nothing, just convert and run validation.
    true Alias for both, for backwards compatibility. Will be removed in 0.23.
    false Alias for docs, for backwards compatibility. Will be removed in 0.23.

Bug Fixes

  • TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
  • For compatibility with JSDoc, TypeDoc will now strip <caption> elements from @example tags, resolves #1679.
  • TypeScript's emitDeclarationOnly compiler option is now supported, resolves #1716.
  • Fixed discovery of tsconfig.json when the provided path ends in .json, resolves #1712.
  • Fixed a crash when converting the globalThis namespace, could only be caused by a plugin.

Thanks!

Don't miss a new typedoc release

NewReleases is sending notifications on new releases.