Skip to content

fix: Update 'onCaughtError' type inference in 'RenderOptions' to work with React v19 #1438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aicest wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −5
Open

fix: Update 'onCaughtError' type inference in 'RenderOptions' to work with React v19 #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6f3201
fix: Update 'onCaughtError' type inference in 'RenderOptions' to work…
aicest May 28, 2025
5c7fef7
Update types/test.tsx
aicest Dec 20, 2025
a970da6
Apply suggestion from @Copilot
aicest Dec 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export interface RenderOptions<
* @see {@link https://react.dev/reference/react-dom/client/createRoot#parameters createRoot#options}
*/
onCaughtError?: ReactDOMClient.RootOptions extends {
onCaughtError: infer OnCaughtError
onCaughtError?: infer OnCaughtError
}
? OnCaughtError
: never
Expand Down
19 changes: 15 additions & 4 deletions types/test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,11 +264,22 @@ export function testContainer() {
}

export function testErrorHandlers() {
// React 19 types are not used in tests. Verify manually if this works with `"@types/react": "npm:types-react@rc"`
// This test runs under both React 18 and React 19 types. For React 19, verify that this works with `"@types/react": "npm:types-react@rc"`.
render(null, {
// Should work with React 19 types
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
// This option is intended to type-check successfully with React 19 types
// but to fail (produce a type error) with React 18 types.
//
// > Why use `@ts-ignore` instead of `@ts-expect-error`?
// > Semantically, `@ts-expect-error` would be the right choice here:
// > it would fail under React 18 types and be unused under React 19 types.
// > However, when running with React 19 types, TypeScript reports that
// > `@ts-expect-error` is unused, which causes unwanted noise in CI.
// > To avoid those unused-directive diagnostics while still supporting
// > both React 18 and React 19 typings, we pragmatically use `@ts-ignore`,
// > acknowledging that it suppresses any real type errors at this site.
//
// eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error
// @ts-ignore
onCaughtError: () => {},
})
render(null, {
Expand Down