Require and return a numeric MotionValue in useSpring types #2702
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.
The current types for
useSpring
useMotionValue<any>
, even though in practiceuseSpring
only handles numeric MotionValues.Since
useSpring
only accepts numeric inputs and only returns a numeric MotionValue, it should be typed withMotionValue<number>
in order to be as specific as possible, and encourage as much type safety as possible.It’s common for developers to enable linter rules that protect against unsafe uses of
any
values in TypeScript, since those values are prone to break type safety guarantees. The current types foruseSpring
create such “unsafe” types even though in practice, the value is always a number. See the following example:Closes #2495