NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #4338 most downloaded on npm
Create api documentation for TypeScript projects.
Last release 2 months ago
05 Jul 2026
Ships fairly regularly
a new release about every 4 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
12 years old
350 releases · first in 2014
Detect visibility modifiers on accessors (46be74e), closes #1516
One column per quarter.
Pick up optional/readonly from mapped types (a2d9dd8), closes #1509
Support for specifying comments on export declarations (7b7bf66), closes #1504
add support for non .com gh enterprise domains
Missing namespace members when ns is created by re-exporting an entire module (7dfadcf), closes #1499
Import from shiki rather than shiki-themes (1c37702), closes #1496
Missing exported members in file-as-namespace reflection (1423960), closes #1493
Avoid crash with removed project reflection (fa95b07), closes #1489
Support for --watch, --preserveWatchOutput, --emit
Static methods added to the class manually in JS (687ae53), closes #1481
CommonJS export= with type exports (4a539dd), closes #1476
Comments on projects were broken
Crash when converting @types/ws (b8071c6), closes #1463
@types/ws (b8071c6), closes #1463@enum tags (66c1652), closes #1464@types/ws, closes #1463@enum tags, closes #1464Add support for optional types (28c234e), closes #1312
Use type nodes if converting a regular function (d528c69), closes #1454
Add support for import types (37e8a3c), closes #1453
Crash when converting a generic with a tuple constraint (685cd3e), closes #1449
Errors due to bad options in tsconfig file were dropped (f76b521), closes #1444
Parameter declarations might not exist (1886304), closes #1443
CLI should not exit cleanly on unexpected error
Tuples could cause a crash (b4da1ca), closes #1439
Properly resolve type parameters (60b6506), closes #1438
Functions might not have a parent in global files (d739298), closes #1436
--excludeNotDocumented didn't remove reflections (5ebbd0f), closes #1435
Improved support for global files (5882e44), closes #1424
ArgumentsReader should warn if missing a value (02b915d), closes #1429
Initializers should only be included if "simple" (5bf4d05), closes #1288 #1224 #764
With this in mind, there are several breaking changes that will likely effect you:
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), entryPointinputFiles has been renamed to entryPoints 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:
npx typedoc src/index.ts
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:
/**
* @module myLibrary
*/
[@module](https://github.com/module) tag (15cb73c)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 access context.program. If they need access to a TS program, they should instead use context.programs and find the one they are interested in.Thank you to everyone who helped test the 0.20 beta, and the following code contributors:
@module tagNothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →