Skip to content

Commit f6e10bb

Browse files
chore(deps): update dependency typedoc to ^0.28.0 (#198)
This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Adoption](https://docs.renovatebot.com/merge-confidence/) | [Passing](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---|---|---| | [typedoc](https://typedoc.org) ([source](https://redirect.github.com/TypeStrong/TypeDoc)) | [`^0.27.5` → `^0.28.0`](https://renovatebot.com/diffs/npm/typedoc/0.27.9/0.28.19) | ![age](https://developer.mend.io/api/mc/badges/age/npm/typedoc/0.28.19?slim=true) | ![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typedoc/0.28.19?slim=true) | ![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typedoc/0.27.9/0.28.19?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typedoc/0.27.9/0.28.19?slim=true) | --- ### Release Notes <details> <summary>TypeStrong/TypeDoc (typedoc)</summary> ### [`v0.28.19`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02819-2026-04-12) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.18...v0.28.19) ##### Features - Added French translations for the TypeDoc interface and help descriptions. - Added support for `triple-slash` comment style, which requires exactly three slashes in the comment, [#&#8203;3089](https://redirect.github.com/TypeStrong/TypeDoc/issues/3089). ##### Bug Fixes - Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme. - Fixed short summary comment handling on module pages when the project source files use Windows line endings, [#&#8203;3093](https://redirect.github.com/TypeStrong/TypeDoc/issues/3093). ##### Thanks! - [@&#8203;avivkeller](https://redirect.github.com/avivkeller) - [@&#8203;hyosua](https://redirect.github.com/hyosua) - [@&#8203;marijnh](https://redirect.github.com/marijnh) - [@&#8203;Pistonight](https://redirect.github.com/Pistonight) ### [`v0.28.18`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02818-2026-03-23) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.17...v0.28.18) ##### Features - Support TypeScript 6.0, [#&#8203;3084](https://redirect.github.com/TypeStrong/TypeDoc/issues/3084). ### [`v0.28.17`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02817-2026-02-13) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.16...v0.28.17) ##### Bug Fixes - Improved handling of comments for type aliases which have been declaration merged with functions, [#&#8203;3064](https://redirect.github.com/TypeStrong/TypeDoc/issues/3064). - Fixed anchor link generation to members named `$`, [#&#8203;3065](https://redirect.github.com/TypeStrong/TypeDoc/issues/3065). - Corrected typing of the `plugin` option to permit functions, [#&#8203;3066](https://redirect.github.com/TypeStrong/TypeDoc/issues/3066). - Warnings about unused `@param` tags will now be properly suppressed when they come from declaration files and the suppressCommentWarningsInDeclarationFiles option is enabled, [#&#8203;3070](https://redirect.github.com/TypeStrong/TypeDoc/issues/3070). - Fixed conversion of types referencing type parameters on functions, [#&#8203;3071](https://redirect.github.com/TypeStrong/TypeDoc/issues/3071). ##### Thanks! - [@&#8203;pjeby](https://redirect.github.com/pjeby) ### [`v0.28.16`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02816-2026-01-12) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.15...v0.28.16) ##### Bug Fixes - Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, [#&#8203;3052](https://redirect.github.com/TypeStrong/TypeDoc/issues/3052). - Fixed an issue preventing automatic entry point discovery on Windows, [#&#8203;3057](https://redirect.github.com/TypeStrong/TypeDoc/issues/3057). - Improved vertical positioning of text icons, [#&#8203;3056](https://redirect.github.com/TypeStrong/TypeDoc/issues/3056). - TypeDoc no longer includes source location information for type literal reflections. This could sometimes cause TypeDoc to infer the wrong path when resolving base paths for display. - Adjusted markdown rendering to allow `markdownItLoader` to override more rendering [#&#8203;3055](https://redirect.github.com/TypeStrong/TypeDoc/issues/3055). ##### Features - Added support for regions for `@include` in `.tsx`, `.cjs`, and `.mjs` file references [#&#8203;3048](https://redirect.github.com/TypeStrong/TypeDoc/issues/3048). - Comments for TS-in-JS `@typedef` tags may now specify modifier tags with the inline tag syntax `{@&#8203;mod}`. This makes it possible to add modifier tags to these members, which previously was not possible as TypeScript's parsing stops for these members at the next non-braced tag, [#&#8203;2916](https://redirect.github.com/TypeStrong/TypeDoc/issues/2916) and [#&#8203;3050](https://redirect.github.com/TypeStrong/TypeDoc/issues/3050). - A `typedoc-config.schema.json` is now included in the root of the package with a JSON schema for TypeDoc's configuration file. The schema for the latest version is also published at <https://typedoc.org/schema.json> and will automatically be picked up when writing typedoc.json files if you are using VSCode, [#&#8203;3054](https://redirect.github.com/TypeStrong/TypeDoc/issues/3054). ##### Thanks! - [@&#8203;a10nik](https://redirect.github.com/a10nik) - [@&#8203;kozi](https://redirect.github.com/kozi) - [@&#8203;Lakuna](https://redirect.github.com/Lakuna) ### [`v0.28.15`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02815-2025-11-29) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.14...v0.28.15) ##### Features - The `gitRevision` option now accepts the special value `{branch}`, which indicates source links should use the current git branch for links, [#&#8203;3041](https://redirect.github.com/TypeStrong/TypeDoc/issues/3041). - Introduced `validation.invalidPath` for suppressing warnings caused by referencing relative paths which do not exist when building the documentation, [#&#8203;3033](https://redirect.github.com/TypeStrong/TypeDoc/issues/3033). - API: Introduced `Logger.validationWarning` for validation which occurs during conversion rather than during TypeDoc's normal validation step, [#&#8203;3033](https://redirect.github.com/TypeStrong/TypeDoc/issues/3033). ### [`v0.28.14`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02814-2025-10-11) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.13...v0.28.14) ##### Features - Introduced the `preservedTypeAnnotationTags` option to specify tags whose type annotations should be copied to the output documentation, [#&#8203;3020](https://redirect.github.com/TypeStrong/TypeDoc/issues/3020). API: Introduced `typeAnnotation` on `CommentTag` - Added `excludePrivateClassFields` option to hide `#private` members while allowing `private` members, [#&#8203;3017](https://redirect.github.com/TypeStrong/TypeDoc/issues/3017). - Added support for TypeScript's `@this` tag for JS files which describe `this` parameters, [#&#8203;3026](https://redirect.github.com/TypeStrong/TypeDoc/issues/3026). ### [`v0.28.13`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02813-2025-09-14) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.12...v0.28.13) ##### Features - The `basePath` option now also affects relative link resolution, TypeDoc will also check for paths relative to the provided base path. If you instead want TypeDoc to only change the rendered base path for sources, use the `displayBasePath` option, [#&#8203;3009](https://redirect.github.com/TypeStrong/TypeDoc/issues/3009). ##### Bug Fixes - Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, [#&#8203;3007](https://redirect.github.com/TypeStrong/TypeDoc/issues/3007). - `@inheritDoc` will now correctly overwrite `@remarks` and `@returns` blocks on the target comment, [#&#8203;3012](https://redirect.github.com/TypeStrong/TypeDoc/issues/3012). - The `externalSymbolLinkMappings` option now works properly on links pointing to inherited/overwritten signatures, [#&#8203;3014](https://redirect.github.com/TypeStrong/TypeDoc/issues/3014). ### [`v0.28.12`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02812-2025-09-01) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.11...v0.28.12) ##### Bug Fixes - Variables marked with `@enum` now work for symbols imported from another module, [#&#8203;3003](https://redirect.github.com/TypeStrong/TypeDoc/issues/3003). - Improved magic introduced with [#&#8203;2999](https://redirect.github.com/TypeStrong/TypeDoc/issues/2999) to work with imported symbols, [#&#8203;3003](https://redirect.github.com/TypeStrong/TypeDoc/issues/3003). - Fixed relative link resolution to file names containing percent encoded URLs, [#&#8203;3006](https://redirect.github.com/TypeStrong/TypeDoc/issues/3006). - Linking to the project's README file with a relative link will now behave as expected, [#&#8203;3006](https://redirect.github.com/TypeStrong/TypeDoc/issues/3006). - Reduced unnecessary HTML element rendering in default theme. API: `Reflection.hasComment` and `Comment.hasVisibleComponent` now accepts an optional `notRenderedTags` parameter. ### [`v0.28.11`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02811-2025-08-25) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.10...v0.28.11) ##### Features - Object properties declared with shorthand property assignment will now use the variable's comment if they do not have their own comment, [#&#8203;2999](https://redirect.github.com/TypeStrong/TypeDoc/issues/2999). ##### Bug Fixes - Fixed link resolution not working correctly in first comment on the file in some cases, [#&#8203;2994](https://redirect.github.com/TypeStrong/TypeDoc/issues/2994). - Optional methods are now rendered with a trailing `?` in the reflection preview and signature, [#&#8203;2995](https://redirect.github.com/TypeStrong/TypeDoc/issues/2995). - The `compilerOptions` option now functions properly with non-boolean options, [#&#8203;3000](https://redirect.github.com/TypeStrong/TypeDoc/issues/3000). - Configuration errors within the `compilerOptions` option are now handled gracefully, [#&#8203;3000](https://redirect.github.com/TypeStrong/TypeDoc/issues/3000). - Fixed improper casing of "Type Declaration" header, [#&#8203;3002](https://redirect.github.com/TypeStrong/TypeDoc/issues/3002). ### [`v0.28.10`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02810-2025-08-10) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.9...v0.28.10) ##### Bug Fixes - Fixed inconsistent anchors on module pages for re-exports, [#&#8203;2990](https://redirect.github.com/TypeStrong/TypeDoc/issues/2990). - Markdown references which appear to be footnotes will no longer be checked for links, [#&#8203;2991](https://redirect.github.com/TypeStrong/TypeDoc/issues/2991). ### [`v0.28.9`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0289-2025-08-01) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.8...v0.28.9) ##### Features - Add support for TypeScript 5.9, [#&#8203;2989](https://redirect.github.com/TypeStrong/TypeDoc/issues/2989). ##### Bug Fixes - Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, [#&#8203;2982](https://redirect.github.com/TypeStrong/TypeDoc/issues/2982). - Fixed automatic discovery of entry points when not running in packages mode, [#&#8203;2988](https://redirect.github.com/TypeStrong/TypeDoc/issues/2988). - Fixed discovery of package.json file when running with entry points containing a glob, [#&#8203;2985](https://redirect.github.com/TypeStrong/TypeDoc/issues/2985). ### [`v0.28.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0288-2025-07-28) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.7...v0.28.8) ##### Features - If using JS config files, the `plugin` function can now be given plugin functions to load. - Permit `-` within tag names to support `typescript-json-schema`'s `@TJS-type` tag, [#&#8203;2972](https://redirect.github.com/TypeStrong/TypeDoc/issues/2972). - Exposed `Context.createSymbolId` for use by plugins. ##### Bug Fixes - Relative links in `<img srcset>` will now be discovered by TypeDoc, [#&#8203;2975](https://redirect.github.com/TypeStrong/TypeDoc/issues/2975). - Relative links in `<source src>` and `<source srcset>` elements will now be discovered by TypeDoc, [#&#8203;2975](https://redirect.github.com/TypeStrong/TypeDoc/issues/2975). - Improved inherited from/overwrites link discovery to point to parent properties in more cases, [#&#8203;2978](https://redirect.github.com/TypeStrong/TypeDoc/issues/2978) ##### Thanks! - [@&#8203;jonathanhefner](https://redirect.github.com/jonathanhefner) - [@&#8203;laymonage](https://redirect.github.com/laymonage) ### [`v0.28.7`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0287-2025-06-30) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.6...v0.28.7) ##### Features - Introduced the `@sortStrategy` tag to override the `sort` option on a specific reflection, [#&#8203;2965](https://redirect.github.com/TypeStrong/TypeDoc/issues/2965). ##### Bug Fixes - Classes and functions exported with `export { type X }` are no longer missing comments, [#&#8203;2970](https://redirect.github.com/TypeStrong/TypeDoc/issues/2970). - Setting `locale` to an unknown value will now cause TypeDoc to operate in English instead of a debug locale. - Array options will now report an error if set to a non-array/non-string value. ### [`v0.28.6`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0286-2025-06-27) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.5...v0.28.6) ##### Features - TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, [#&#8203;2961](https://redirect.github.com/TypeStrong/TypeDoc/issues/2961). - Declarations without comments will now check for comments on their export specifier, [#&#8203;2964](https://redirect.github.com/TypeStrong/TypeDoc/issues/2964). ##### Bug Fixes - Attempting to highlight a supported language which is not enabled is now a warning, not an error, [#&#8203;2956](https://redirect.github.com/TypeStrong/TypeDoc/issues/2956). - Improved compatibility with CommonMark's link parsing, [#&#8203;2959](https://redirect.github.com/TypeStrong/TypeDoc/issues/2959). - Classes, variables, and functions exported with `export { type X }` are now detected and converted as interfaces/type aliases, [#&#8203;2962](https://redirect.github.com/TypeStrong/TypeDoc/issues/2962). - Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, [#&#8203;2967](https://redirect.github.com/TypeStrong/TypeDoc/issues/2967). - Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, [#&#8203;2969](https://redirect.github.com/TypeStrong/TypeDoc/issues/2969). ##### Thanks! - [@&#8203;yGuy](https://redirect.github.com/yGuy) ### [`v0.28.5`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0285-2025-05-26) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.4...v0.28.5) ##### Bug Fixes - References to type aliases defined as mapped types will now correctly create a reference to the type alias, [#&#8203;2954](https://redirect.github.com/TypeStrong/TypeDoc/issues/2954). - `ignoredHighlightLanguages` can now be used to prevent warnings for codeblocks containing languages which are supported by Shiki but are not loaded, [#&#8203;2956](https://redirect.github.com/TypeStrong/TypeDoc/issues/2956). ### [`v0.28.4`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0284-2025-05-04) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.3...v0.28.4) ##### Features - The navigation in the default theme will now attempt to break long names onto multiple lines, [#&#8203;2940](https://redirect.github.com/TypeStrong/TypeDoc/issues/2940). - Added German (de) localization, [#&#8203;2941](https://redirect.github.com/TypeStrong/TypeDoc/issues/2941). ##### Bug Fixes - TypeDoc's default theme now uses the same chevron for all collapsible elements, [#&#8203;2924](https://redirect.github.com/TypeStrong/TypeDoc/issues/2924) The `chevronSmall` helper is now deprecated and will be removed with v0.29.0. - Classes/interfaces marked with `@hidden` will no longer appear in the "Hierarchy" section of the docs. - TypeDoc now handles wildcard JSDoc types, [#&#8203;2949](https://redirect.github.com/TypeStrong/TypeDoc/issues/2949). ##### Thanks! - [@&#8203;blutorange](https://redirect.github.com/blutorange) - [@&#8203;bkeepers](https://redirect.github.com/bkeepers) ### [`v0.28.3`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0283-2025-04-20) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.2...v0.28.3) ##### Bug Fixes - `@inline` now functions when referencing tuple types, [#&#8203;2932](https://redirect.github.com/TypeStrong/TypeDoc/issues/2932). - `@link` links to the current page are now rendered, [#&#8203;2934](https://redirect.github.com/TypeStrong/TypeDoc/issues/2934). - `@includeCode` now supports regions in TypeScript files with `.mts` and `.cts` file extensions, [#&#8203;2935](https://redirect.github.com/TypeStrong/TypeDoc/issues/2935). - Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, [#&#8203;2937](https://redirect.github.com/TypeStrong/TypeDoc/issues/2937). - Improved error reporting when paths including Windows separators are provided as globs, [#&#8203;2938](https://redirect.github.com/TypeStrong/TypeDoc/issues/2938). ### [`v0.28.2`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0282-2025-04-07) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.1...v0.28.2) ##### Features - `@group none` and `@category none` will now render their children without a section heading in the default theme, [#&#8203;2922](https://redirect.github.com/TypeStrong/TypeDoc/issues/2922). - Added `@disableGroups` tag to completely disable the grouping mechanism for a given reflection, [#&#8203;2922](https://redirect.github.com/TypeStrong/TypeDoc/issues/2922). ##### Bug Fixes - Variables using `@class` now correctly handle `@category`, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - Variables using `@class` now include constructor parameters, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - Variables using `@class` with a generic first constructor function now adopt that function's type parameters as the class type parameters, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, [#&#8203;2918](https://redirect.github.com/TypeStrong/TypeDoc/issues/2918). - Inlining types can now handle more type variants, [#&#8203;2920](https://redirect.github.com/TypeStrong/TypeDoc/issues/2920). - Fixed behavior of `externalSymbolLinkMappings` option when URL is set to `#`, [#&#8203;2921](https://redirect.github.com/TypeStrong/TypeDoc/issues/2921). - Fixed broken links within module pages when structure-dir router was used, [#&#8203;2928](https://redirect.github.com/TypeStrong/TypeDoc/issues/2928). - Type parameters on JS classes defined with `@typedef` now correctly handle the constraint, [#&#8203;2929](https://redirect.github.com/TypeStrong/TypeDoc/issues/2929). - API: `toString` on types containing index signatures now behave correctly, [#&#8203;2917](https://redirect.github.com/TypeStrong/TypeDoc/issues/2917). - Added `@inlineType` to the list of tags excluded by default. ### [`v0.28.1`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02814-2025-10-11) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.0...v0.28.1) ##### Features - Introduced the `preservedTypeAnnotationTags` option to specify tags whose type annotations should be copied to the output documentation, [#&#8203;3020](https://redirect.github.com/TypeStrong/TypeDoc/issues/3020). API: Introduced `typeAnnotation` on `CommentTag` - Added `excludePrivateClassFields` option to hide `#private` members while allowing `private` members, [#&#8203;3017](https://redirect.github.com/TypeStrong/TypeDoc/issues/3017). - Added support for TypeScript's `@this` tag for JS files which describe `this` parameters, [#&#8203;3026](https://redirect.github.com/TypeStrong/TypeDoc/issues/3026). ### [`v0.28.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0280-2025-03-15) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.27.9...v0.28.0) ##### Breaking Changes - TypeDoc now expects all input globs paths to be specified with `/` path separators, [#&#8203;2825](https://redirect.github.com/TypeStrong/TypeDoc/issues/2825). - TypeDoc's `--entryPointStrategy merge` mode now requires JSON from at least version 0.28.0. - Removed `jp` translations from `lang`, to migrate switch to `ja`. - File name references in `intentionallyNotExported` now use a package name/package relative path instead of an absolute path for matching. - The `source-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 discovered `package.json` file if `--readme` is not set this change improves handling of monorepo setups where some packages have readme files and others do not, [#&#8203;2875](https://redirect.github.com/TypeStrong/TypeDoc/issues/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, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/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, [#&#8203;2817](https://redirect.github.com/TypeStrong/TypeDoc/issues/2817). ##### API Breaking Changes - `ProjectReflection.getReflectionFromSymbol` and `ProjectReflection.getSymbolFromReflection` have been moved to `Context` - `Path` and `PathArray` parameter types now always contain normalized paths. - Introduced a `Router` which is used for URL creation. `Reflection.url`, `Reflection.anchor`, and `Reflection.hasOwnDocument` have been removed. - `Deserializer.reviveProject(s)` no longer accepts an option to add project documents. - `Deserializer.reviveProjects` now requires an `alwaysCreateEntryPointModule` 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. The `fileName` property will be present when initially created, but is not serialized. - Removed `DeclarationReflection.relevanceBoost` attribute which was added for plugins, but never used. - `i18n` proxy is no longer passed to many functions, instead, reference `i18n` exported from the module directly. - `ReflectionKind.singularString` and `ReflectionKind.pluralString` now returns translated strings. The methods on `Internationalization` to do this previously have been removed. - The HTML output structure for the search box has changed to support the new modal. - `DefaultThemeRenderContext`'s `typeDeclaration` and `typeDetailsIfUseful` 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, [#&#8203;2111](https://redirect.github.com/TypeStrong/TypeDoc/issues/2111). - Introduced the `@primaryExport` modifier tag to provide more fine grained control over export conversion order, [#&#8203;2856](https://redirect.github.com/TypeStrong/TypeDoc/issues/2856) - Introduced `packagesRequiringDocumentation` option for `validation.notDocumented`, TypeDoc will expect comments to be present for symbols in the specified packages. - TypeDoc now exports a `typedoc/browser` entrypoint for parsing and using serialized JSON files, [#&#8203;2528](https://redirect.github.com/TypeStrong/TypeDoc/issues/2528). - Type `packageOptions` as `Partial<TypeDocOptions>`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - TypeDoc will now warn if an option which should only be set at the root level is set in `packageOptions`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - Introduced `@function` tag to force TypeDoc to convert variable declarations with a type annotation as functions, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/2881). - Exposed a `TypeDoc` global object in the HTML theme which can be used to prevent TypeDoc from using `localStorage`, [#&#8203;2872](https://redirect.github.com/TypeStrong/TypeDoc/issues/2872). - Introduced `@preventInline` and `@inlineType` tags for further control extending the `@inline` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - Introduced `@preventExpand` and `@expandType` tags for further control extending the `@expand` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - API: Introduced `DefaultThemeRenderContext.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, [#&#8203;2824](https://redirect.github.com/TypeStrong/TypeDoc/issues/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, [#&#8203;2876](https://redirect.github.com/TypeStrong/TypeDoc/issues/2876). - Fixed rendering of function types within arrays and union types, [#&#8203;2892](https://redirect.github.com/TypeStrong/TypeDoc/issues/2892). - Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, [#&#8203;2894](https://redirect.github.com/TypeStrong/TypeDoc/issues/2894). ##### Thanks! - [@&#8203;crimx](https://redirect.github.com/crimx) - [@&#8203;jsmith2-coveo](https://redirect.github.com/jsmith2-coveo) - [@&#8203;phoneticallySAARTHaK](https://redirect.github.com/phoneticallySAARTHaK) - [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha) </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/GSTJ/react-native-magic-modal). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xODUuMSIsInVwZGF0ZWRJblZlciI6IjQzLjE4NS4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
1 parent d89193f commit f6e10bb

2 files changed

Lines changed: 38 additions & 37 deletions

File tree

packages/modal/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
"shx": "^0.4.0",
9090
"ts-jest": "^29.2.5",
9191
"ts-node-dev": "^2.0.0",
92-
"typedoc": "^0.27.5",
92+
"typedoc": "^0.28.0",
9393
"typescript": "^5.7.2"
9494
}
9595
}

pnpm-lock.yaml

Lines changed: 37 additions & 36 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)