Skip to content

fix(router-core): update ErrorComponentProps to not support generic error type #4727

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(router-core): update ErrorComponentProps to not support generic error type #4727

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
690778e
fix: update ErrorRouteComponent to support generic error types
leesb971204 Jul 21, 2025
7e247dd
fix: simplify ErrorRouteComponent type definition by removing generic…
leesb971204 Aug 13, 2025
524a5bc
docs(router): update errorComponentComponent.md
leesb971204 Aug 13, 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 docs/router/framework/react/api/router/errorComponentComponent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `ErrorComponent` component accepts the following props:

### `props.error` prop

- Type: `TError` (defaults to `Error`)
- Type: `Error`
- The error that was thrown by the component's children

### `props.info` prop
Expand Down
4 changes: 2 additions & 2 deletions packages/router-core/src/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1317,8 +1317,8 @@ export type ErrorRouteProps = {
reset: () => void
}

export type ErrorComponentProps<TError = Error> = {
error: TError
export type ErrorComponentProps = {
error: Error
Comment on lines +1320 to +1321
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the scope of the errorComponent covers both errors from the loader and errors from the component itself, using the Error type is appropriate

Copy link

@michaelbull michaelbull Sep 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to undo the work of making it handle throwing of non-errors. What if my loader calls some third-party API that internally does throw "Some string" or throw 50? Loaders can throw more than just Errors, and in some situations the user is not in control of what could be thrown.

Copy link
Contributor Author

@leesb971204 leesb971204 Sep 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaelbull

That’s right. But since in most cases the error is returned as Error, I think it makes sense to set the type to Error by default, and if needed, the user can manually override the error type using something like declare. Please refer to the link.

info?: { componentStack: string }
reset: () => void
}
Expand Down