You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
compilerOptions
Used to selectively override compiler options for generating documentation. Values set with this option will override options read from tsconfig.json.
And there is an example of overriding strictNullChecks. But what does it mean to override strictNullChecks for typedoc? I wouldn't expect a documentation generator to be doing null checks, so I wouldn't expect that to have any effect. In general I am curious why this option exists / when you would use it. The docs / example are confusing to me as-is.
The text was updated successfully, but these errors were encountered:
#1891 - the original implementing PR has a use case.
TypeDoc uses type information, so it runs the TS compiler. It can be useful to be able to configure it with different options than are present in the tsconfig
See TypeStrong/typedoc#2143 for context. I found it confusing to be setting TypeScript compiler options on a doc generator. Hopefully my edit will make it a little clearer / help people find appropriate context in the context. Feel free to reject if you're not a fan. No biggie.
Thanks for the explanation! Sorry for not acknowledging it earlier. I wanted to create a PR against the docs, but was super slow to do so. Feel free to accept or reject as you see fit.
The docs say:
And there is an example of overriding
strictNullChecks
. But what does it mean to override strictNullChecks for typedoc? I wouldn't expect a documentation generator to be doing null checks, so I wouldn't expect that to have any effect. In general I am curious why this option exists / when you would use it. The docs / example are confusing to me as-is.The text was updated successfully, but these errors were encountered: