TypeScript updates #8190
Merged
TypeScript updates #8190
Conversation
This file contains hidden or 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
core.controller.js's implementation also passes the Chart instance as `this`. However, that isn't documented, and it's my impression that Chart.js is moving away from passing items as `this`, so I didn't declare it in the type definitions.
The previous definition resolved to `{}` (which can allow primitives) if it was given a function, so it was far too broad for any `Scriptable<>` properties.
Document the `fn` option, since it's in the type definitions. Fix callback usage to match example code.
The onProgress and onComplete events were mistakenly declared as taking the standard DOM AnimationEvent. (Should Chart.js's AnimationEvent be renamed to ChartAnimationEvent to avoid any possible ambiguity?)
kurkle
approved these changes
Dec 18, 2020
etimberg
approved these changes
Dec 18, 2020
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This addresses several mistakes I found in the TypeScript type definitions in my project. See individual commits' commit messages for details.
Specific notes and questions:
types/index.esm.d.tsto help explain this, but if there's a better way to communicate or a better place to document, please let me know.thisas the item being operated on: several of the existing TypeScript definitions allow it, and the existing implementation does it, but I got the impression from Chart.js 3.x change lists and migration documentation that the code is moving away from it, so maybe it's in the process of being deprecated? Therefore, I omitted athisparameter from the types I updated, but if it should be there, I'm happy to add it.