fix(types): do not use reference tags
#563
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
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.
In TypeScript,
/// <referencetags affect the whole environment, meaning that if a single dependency makes use of the tag, the user's global environment would be polluted with these types. The correct way of importing DOM types is by specifying them in thelibproperty oftsconfig.json, which this library already does.Without the fix, using window in a project that installed @napi-rs/canvas that doesn't use DOM types
After the change, global scope is no longer polluted with DOM types for the project that installed this lib
Some examples of global pollution can be found at https://gist.github.com/RyanCavanaugh/702ebd1ca2fc060e58e634b4e30c1c1c