fix: Update 'onCaughtError' type inference in 'RenderOptions' to work with React v19 #1438
+16
−5
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit a970da6:
|
There was a problem hiding this comment.
Pull request overview
This PR fixes TypeScript type inference for the onCaughtError option in RenderOptions to properly support React 19. The fix addresses an issue where the conditional type check was too strict, requiring the property to be non-optional when React 19's RootOptions defines it as optional.
Key changes:
- Updated the conditional type in
RenderOptionsto check for optionalonCaughtError?instead of requiredonCaughtError - Changed test file directive from
@ts-expect-errorto@ts-ignoreto maintain compatibility with both React 18 and 19 type checking in CI
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| types/index.d.ts | Made onCaughtError property optional in the conditional type check to match React 19's optional property definition |
| types/test.tsx | Updated test comments and TypeScript directive to use @ts-ignore for cross-version compatibility during CI testing |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Sorry for duplicating PR #1401, as the previous PR couldn't be reopened.
The
entitieslibrary has released version v6.0.1 to correct its TS types, the PR changes should now pass type checks (#1401 (comment)).What: To fix incorrect
onCaughtErrortype inference inRenderOptions.Repro: https://codesandbox.io/p/sandbox/delicate-voice-7wnf7z?file=%2Ftest%2Frender.test-d.ts%3A6%2C5-6%2C28
Why: As explained above.
How: Update TS types.
Checklist:
docs site
- React v18 types: No impact
- React v19 types: Fixed