Update dependency typedoc to ^0.20.32 #63
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.19.2
->^0.20.32
Release Notes
TypeStrong/TypeDoc
v0.20.32
Compare Source
Bug Fixes
v0.20.31
Compare Source
Bug Fixes
Thanks!
v0.20.30
Compare Source
Bug Fixes
v0.20.29
Compare Source
Features
v0.20.28
Compare Source
Bug Fixes
v0.20.27
Compare Source
Bug Fixes
Features
Thanks!
v0.20.26
Compare Source
Bug Fixes
v0.20.25
Compare Source
Features
@module
tag to mark a comment as belonging to a module (7b7bf66)v0.20.24
Compare Source
Features
Thanks!
v0.20.23
Compare Source
Bug Fixes
v0.20.22
Compare Source
Bug Fixes
v0.20.21
Compare Source
Bug Fixes
v0.20.20
Compare Source
Bug Fixes
Features
Thanks!
v0.20.19
Compare Source
Features
v0.20.18
Compare Source
Bug Fixes
v0.20.17
Compare Source
Bug Fixes
Features
Thanks!
v0.20.16
Compare Source
Bug Fixes
v0.20.15
Compare Source
Bug Fixes
@types/ws
(b8071c6), closes #1463@enum
tags (66c1652), closes #1464Features
Thanks!
v0.20.14
Compare Source
Bug Fixes
Thanks!
v0.20.13
Compare Source
Bug Fixes
v0.20.12
Compare Source
Bug Fixes
Thanks!
v0.20.11
Compare Source
Bug Fixes
v0.20.10
Compare Source
Bug Fixes
Changes
typedoc --help
v0.20.9
Compare Source
Bug Fixes
v0.20.8
Compare Source
Bug Fixes
v0.20.7
Compare Source
Bug Fixes
v0.20.6
Compare Source
Bug Fixes
Features
v0.20.5
Compare Source
Bug Fixes
v0.20.4
Compare Source
Bug Fixes
v0.20.3
Compare Source
Features
v0.20.2
Compare Source
Bug Fixes
Features
v0.20.1
Compare Source
Bug Fixes
v0.20.0
Compare Source
Migration from previous versions
Version 0.20 completely reworks how documentation is generated by TypeDoc. In previous versions, there was
--mode file
and--mode modules
, which documented files according to their content on the filesystem. This worked reasonably well before ES modules were commonly used, but was insufficient for the modern ecosystem. In 0.20, TypeDoc documents your project according to what you export.With this in mind, there are several breaking changes that will likely effect you:
mode
,excludeNotExported
,includeDeclarations
,ignoreCompilerErrors
(#1403),entryPoint
inputFiles
has been renamed toentryPoints
to better reflect its usageexclude
has changed, it is now only used to filter entry points if a directory is provided as the entry point.typedoc --help
, it will print a list of all supported highlighting languages.The command line for most projects now should be fairly simple:
If you have more than one entry point, TypeDoc will create a module for each entry point. The module name will be derived from the entry file name. If the derived name is not the desired name, you can use a module comment with the
@module
tag to change it:Bug Fixes
Features
[@module](https://togithub.com/module)
tag (15cb73c)API Breaking changes
Application.generateDocs
,Application.generateJson
now return a promise"string-literal"
type removed, there is now a single"literal"
type that includes string literals, number literals, bigint literals, and nullcontext.fileNames
has been removedisExported
/isConstructorProperty
ReflectionFlags remvoedConverter.EVENT_FUNCTION_IMPLEMENTATION
removed - it was inappropriately used to perform some data extraction, which was unreliable since not all function declarations include an implementationConverter.EVENT_BEGIN
listeners may not accesscontext.program
. If they need access to a TS program, they should instead usecontext.programs
and find the one they are interested in.Thanks!
Thank you to everyone who helped test the 0.20 beta, and the following code contributors:
Renovate configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻️ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.