This repository was archived by the owner on Jul 13, 2025. It is now read-only.
chore(deps): update dependency typedoc to v0.28.7#1176
Open
renovate[bot] wants to merge 1 commit intomasterfrom
Open
chore(deps): update dependency typedoc to v0.28.7#1176renovate[bot] wants to merge 1 commit intomasterfrom
renovate[bot] wants to merge 1 commit intomasterfrom
Conversation
3a52fb2 to
a827560
Compare
a827560 to
54c794a
Compare
54c794a to
9927bb3
Compare
9927bb3 to
68ccffe
Compare
68ccffe to
059f547
Compare
059f547 to
0d2d6eb
Compare
0d2d6eb to
466c5a3
Compare
466c5a3 to
9eb42b6
Compare
9eb42b6 to
389385d
Compare
389385d to
a01c2d9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.27.6->0.28.7Release Notes
TypeStrong/TypeDoc (typedoc)
v0.28.7Compare Source
Features
@sortStrategytag to override thesortoption on a specific reflection, #2965.Bug Fixes
export { type X }are no longer missing comments, #2970.localeto an unknown value will now cause TypeDoc to operate in English instead of a debug locale.v0.28.6Compare Source
Features
Bug Fixes
export { type X }are now detected and converted as interfaces/type aliases, #2962.Thanks!
v0.28.5Compare Source
Bug Fixes
ignoredHighlightLanguagescan now be used to prevent warnings for codeblocks containing languageswhich are supported by Shiki but are not loaded, #2956.
v0.28.4Compare Source
Features
Bug Fixes
The
chevronSmallhelper is now deprecated and will be removed with v0.29.0.@hiddenwill no longer appear in the"Hierarchy" section of the docs.
Thanks!
v0.28.3Compare Source
Bug Fixes
@inlinenow functions when referencing tuple types, #2932.@linklinks to the current page are now rendered, #2934.@includeCodenow supports regions in TypeScript files with.mtsand.ctsfile extensions, #2935.v0.28.2Compare Source
Features
@group noneand@category nonewill now render their children without a sectionheading in the default theme, #2922.
@disableGroupstag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@classnow correctly handle@category, #2914.@classnow include constructor parameters, #2914.@classwith a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappingsoption when URL is set to#, #2921.@typedefnow correctly handle the constraint, #2929.toStringon types containing index signatures now behave correctly, #2917.@inlineTypeto the list of tags excluded by default.v0.28.1Compare Source
Features
TypeDocOptionsinterface now marks options as optional so it no longer has to be wrapped inPartialfor use in config files, #2901.
localStoragewithout clearing it, #2908.Bug Fixes
--watchcan now infer entry points frompackage.jsonas supported in non-watch mode, #2899.@includewith regions now works on files with CRLF line endings, #2902.module.exports = [], #2909../in relative links, #2910.Thanks!
v0.28.0Compare Source
Breaking Changes
/path separators, #2825.--entryPointStrategy mergemode now requires JSON from at least version 0.28.0.jptranslations fromlang, to migrate switch toja.intentionallyNotExportednow use a package name/package relative path instead of an absolute path for matching.source-ordersort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.jsonfile if--readmeis not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@functiontag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbolandProjectReflection.getSymbolFromReflectionhave been moved toContextPathandPathArrayparameter types now always contain normalized paths.Routerwhich is used for URL creation.Reflection.url,Reflection.anchor, andReflection.hasOwnDocumenthave been removed.Deserializer.reviveProject(s)no longer accepts an option to add project documents.Deserializer.reviveProjectsnow requires analwaysCreateEntryPointModuleoption.Comment.serializeDisplayPartsno longer requires a serializer argument.ReflectionSymbolId.fileNameis now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileNameproperty will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoostattribute which was added for plugins, but never used.i18nproxy is no longer passed to many functions, instead, referencei18nexported from the module directly.ReflectionKind.singularStringandReflectionKind.pluralStringnow returns translated strings.The methods on
Internationalizationto do this previously have been removed.DefaultThemeRenderContext'stypeDeclarationandtypeDetailsIfUsefulmethods now require both a reflection and a type in order to support
@expandTypeFeatures
--routeroption which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@primaryExportmodifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentationoption forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browserentrypoint for parsing and using serialized JSON files, #2528.packageOptionsasPartial<TypeDocOptions>, #2878.packageOptions, #2878.@functiontag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDocglobal object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage, #2872.@preventInlineand@inlineTypetags for further control extending the@inlinetag, #2862.@preventExpandand@expandTypetags for further control extending the@expandtag, #2862.DefaultThemeRenderContext.reflectionIconfor more granular control over displayed reflection icons.Bug Fixes
Thanks!
v0.27.9Compare Source
This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.
Features
v0.27.8Compare Source
Features
visibilityFilteroption now supports individual signatures, #2846.faviconoption may now be given a link starting withhttps?://instead of a path, #2851.#as the link inexternalSymbolLinkMappingsto indicate the type should not be linked to, #2853.Bug Fixes
undefined, #2854.Thanks!
v0.27.7Compare Source
Features
@includeCodeand@inlinecan now inject parts of files using regionnames or line numbers, #2816.
jatranslation options, deprecatedjpin favor ofja, #2843.--watchoption to support watching files not caught byTypeScript's watch mode, #2675.
@inlinetag now works in more places for generic types.Bug Fixes
@classincorrectly handling mapped types, #2842.so that declaration merged members with global symbols can be documented, #2844.
Thanks!
Configuration
📅 Schedule: Branch creation - "every weekday" in timezone Etc/UTC, Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.