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
TypeDoc 0.17 moves TypeScript from a direct dependency to a peer dependency.
This means that when you npm i typedoc, TypeDoc will use the TypeScript version from your project instead of bundling its own. This has some advantages.
You can upgrade TS and use new features even if TypeDoc doesn't support them yet.
However, this means that if you use a version of TypeScript which is incompatible with TypeDoc, you will likely experience crashes. TypeDoc specifies the versions of TypeScript that it expects to be compatible with.
However, if you install an older version of TypeScript, most package managers won't refuse to install the latest TypeDoc, they will give you a warning, but lots of people ignore warnings.
If you are experiencing crashes when using the latest TypeDoc you have two options.
Upgrade your project's TypeScript to a newer version.
Use an older TypeDoc version
I was surprised by how many people have noted that the latest TypeDoc breaks on their system... so I decided this should be a good issue to pin for a couple weeks.
The text was updated successfully, but these errors were encountered:
TypeDoc 0.17 moves TypeScript from a direct dependency to a peer dependency.
This means that when you
npm i typedoc
, TypeDoc will use the TypeScript version from your project instead of bundling its own. This has some advantages.However, this means that if you use a version of TypeScript which is incompatible with TypeDoc, you will likely experience crashes. TypeDoc specifies the versions of TypeScript that it expects to be compatible with.
typedoc/package.json
Lines 33 to 35 in c296503
However, if you install an older version of TypeScript, most package managers won't refuse to install the latest TypeDoc, they will give you a warning, but lots of people ignore warnings.
If you are experiencing crashes when using the latest TypeDoc you have two options.
I was surprised by how many people have noted that the latest TypeDoc breaks on their system... so I decided this should be a good issue to pin for a couple weeks.
The text was updated successfully, but these errors were encountered: