Use @import JSDoc tags for TypeScript >= 5.5 #53
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are easier to read than the
/** @typedef */
workaround, and also take up less space. For each import, a separate@typedef
is required.TypeScript supports
/** @import */
since version 5.5, see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-5.html#the-jsdoc-import-tagI changed it so that it detects the current TypeScript version and uses
@typedef
for version < 5.5, and@import
for versions >= 5.5. Perhaps you could also add an option for which import style to use, but I prefer less options, and@import
seems like the proper way if supported.transpileFile
has an optionaltsVersion
argument, which is needed for tests and could also be used by consumers if needed.