What is compilerOptions for?

This issue has been tracked since 2023-01-16.

The docs say:

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.

Gerrit0 wrote this answer on 2023-01-21

#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

More Details About Repo
Owner Name TypeStrong
Repo Name typedoc
Full Name TypeStrong/typedoc
Language TypeScript
Created Date 2014-05-24
Updated Date 2023-03-19
Star Count 6487
Watcher Count 68
Fork Count 639
Issue Count 48


Issue Title Created Date Updated Date