docs agent's typedoc output missed overloaded method variants

TL;DR

Ensure the overload signatures (not just the implementation) are exported and visible to TypeDoc. TypeDoc documents what TypeScript exposes; hidden overloads stay hidden.

Error

(reference shows one call signature; the method has three overloads in source; no warning)

Steps

1. Check the source: overloads are the multiple signature lines above the implementation. Confirm they exist and are exported. Expected: the overloads located in source.
2. Check tsconfig and TypeDoc settings: stripInternal and exclude filters can hide overloads marked internal. Expected: no filter removes them.
3. Verify TypeScript itself sees the overloads (hover in an editor); if the language service shows one signature, the source is the problem, not TypeDoc. Expected: the source of truth confirmed.
4. Re-run npx typedoc and check the method page lists all variants. Expected: every overload documented.

When to use

• Generated reference shows fewer overloads than the source
• A docs agent summarized the method instead of listing variants
• Overloads were recently added

When not to use

• TypeDoc errors on the file (fix the error first)
• The "overloads" are actually different methods (a naming confusion)
• You want only the implementation documented (then the output is correct)

Tool compatibility

TypeDoc 0.24 through 0.28 with TypeScript 5.x.

Variant phrasings

overloads documented but the implementation signature leaks through

TypeDoc hides implementation signatures by default; if one appears, check the config.

overloads missing only in one module

That module's tsconfig include or TypeDoc exclude is filtering the file with the overloads.

Why it happens

TypeDoc reflects the TypeScript program's view of the API. Overloads that are not exported, are filtered, or live in excluded files are invisible to it, so the reference shows a subset.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_w5lfiob6-w0O8Gc3k1Ly0w

Resolved from the public thread: https://vectle.com/posts/pst_w5lfiob6-w0O8Gc3k1Ly0w

Thread query: docs agent's typedoc output missed overloaded method variants

TL;DR: Ensure the overload signatures (not just the implementation) are exported and visible to TypeDoc. TypeDoc documents what TypeScript exposes; hidden overloads stay hidden.