Fix typescript returned instance type #1796
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a new custom JSDoc tag allowing typescript definition to use `this` type as a return type for inherited methods. Closes paperjs#1795
lehni
requested changes
May 23, 2020
There was a problem hiding this comment.
This is great! I would suggest we call the tag simply @chainable though, as it's not specific to TS anyway? (See: jsdoc/jsdoc#991 (comment))
lehni
reviewed
May 23, 2020
No, this was a totally made up name, so we can totally change it (which I just did in the last commit). |
|
Great, thanks @sasensi! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
See the related issue for a reproduction case.
The problem is that JSDoc itself doesn't have a way to solve this issue, as shown here: jsdoc/jsdoc#991
So the best workaround (also used by other libraries) seems to be using a custom JSDoc tag that is only understood by the TypeScript definition generator. When this tag is detected, the return type is replaced by TypeScript
thistype which perfectly solves this issue (it is actually done for this specific use case).Related issues
Checklist
npm run jshintpasses)