jsdoc: add jsdoc for errors #3589
Closed
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
| this.name = 'UndiciError' | ||
| this.code = 'UND_ERR' | ||
| } | ||
| name = /** @type {string} */ 'UndiciError' |
There was a problem hiding this comment.
Suggested change
| name = /** @type {string} */ 'UndiciError' | |
| /** @type {string} */ | |
| name = 'UndiciError' |
Nit: I prefer for jsdoc comments to be above the relevant line of code. This is better for readability imo
There was a problem hiding this comment.
I prefer them above too. But compare it in the typescript playground.
There was a problem hiding this comment.
You will see the difference immediatly.
|
Did you see what I mean? |
|
sorry I never got back to this, and yeah when put above the code it becomes an actual notation for that thing. i believe that is pretty useful, especially if we start generating docs using these comments. no big deal tho! |
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.
Maybe the style seems strange, but with this style the generated typescript typings will have no additional jsdocs
Functional changes:
HTTPParserError is now an UndiciError and has the Error Code
UND_ERR_HTTP_PARSERAbortError has now an Error Code
UND_ERR_ABORTSee in the ts-playground and select
d.tsin the right window to see the generated types.