Fix TypeScript issue with useAnimatedProps #4653
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
tomekzaw
reviewed
Jul 5, 2023
src/reanimated2/helperTypes.ts
Outdated
| @@ -115,3 +116,11 @@ export type AnimateProps<P extends object> = NonStyleAnimatedProps<P> & | |||
| }; | |||
|
|
|||
| export type AnimatedProps<P extends object> = AnimateProps<P>; | |||
|
|
|||
| export type PropsAdapterFunction = (props: Record<string, unknown>) => void; | |||
There was a problem hiding this comment.
Suggested change
| export type PropsAdapterFunction = (props: Record<string, unknown>) => void; | |
| export type AnimatedPropsAdapterFunction = (props: Record<string, unknown>) => void; |
| const nativePropsToAdd: { [key: string]: boolean } = {}; | ||
| // eslint-disable-next-line no-unused-expressions | ||
| nativeProps?.forEach((prop) => { | ||
| nativePropsToAdd[prop] = true; | ||
| }); | ||
| addWhitelistedNativeProps(nativePropsToAdd); | ||
| return adapter; | ||
| } | ||
| }) as createAnimatedPropAdapterType; |
There was a problem hiding this comment.
Why do we need to cast the whole function instead of just casting the return value?
There was a problem hiding this comment.
If it is not a 'hot fix' I think we should avoid type casting
tomekzaw
approved these changes
Jul 6, 2023
Latropos
pushed a commit
that referenced
this pull request
Jul 13, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. --> ## Summary During the migration from manual types, the proper typing of "useAnimatedProps" has proven to be quite challenging. As a result, I had to resort to casting it to its previous type, but unfortunately, I missed some places. ## Test plan In our new docs the given [example](https://reanimated-beta-docs.swmansion.com/docs/core/useAnimatedProps#adapters-) doesn't work. After applying these changes it's fixed.
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.
Summary
During the migration from manual types, the proper typing of "useAnimatedProps" has proven to be quite challenging. As a result, I had to resort to casting it to its previous type, but unfortunately, I missed some places.
Test plan
In our new docs the given example doesn't work.
After applying these changes it's fixed.