Update withErrorBoundary types for forwards compat #211
+43
−25
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.
What:
This PR updates the
withErrorBoundary()
to work with newer versions of@types/react
Why:
In
@types/[email protected]
(original PR) there was a change published to theforwardRef
type that is incompatible withwithErrorBoundary
. It results in this error:My understanding is that the
props
argument of theforwardRef
callback expects to not have aref
property but theProps extends Object
constraint does not guarantee that. I initially tried to just remove the type annotation on theprops
argument so it will be inferred asReact.PropsWithoutRef<Props>
but I ran into other errors likeArgument of type 'PropsWithoutRef<Props> & { ref: ForwardedRef<ComponentType<Props>>; }' is not assignable to parameter of type '(Attributes & Props) | null | undefined'.
My solution here to was refactor a bit and make the
withErrorBoundary
HOC be parameterized by the component type instead of props type. I also fixed the implementation to useComponentRef<>
since the ref will not always be aComponentType<>
. I believe this will be a breaking TypeScript change to anybody providing a type argument towithErrorBoundary()
and the return type will be different.How:
Checklist: