refactor: improve jsdoc types #69
Open
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
shadow-dahm
reviewed
May 17, 2024
| @@ -1,3 +1,4 @@ | |||
| /// <reference path="types.js" /> | |||
There was a problem hiding this comment.
Q: I have not seen this before with jsdocs, what is it doing?
There was a problem hiding this comment.
its to reference types defined in another file. like a require for types.
Not sure if this is the best way though.
There was a problem hiding this comment.
Interesting, I had no idea importing them was actually required!
shadow-dahm
approved these changes
May 20, 2024
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
This PR:
The end result is a better user experience (intellisense and documentation for the public interface) and a better developer experience for contributors (type hints for internal functions).
References
N/A
Testing
N/A
Checklist