Skip to content

docs: clarify rawErrorResponseSchema timing #5260

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
lilianakatrina684-a11y wants to merge 2 commits into
base: master
Choose a base branch
from
+9 −0
Open

docs: clarify rawErrorResponseSchema timing #5260

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f462e15
docs: clarify rawErrorResponseSchema timing
lilianakatrina684-a11y Mar 21, 2026
1d17307
Merge branch 'master' of https://github.com/reduxjs/redux-toolkit int…
aryaemami59 Apr 4, 2026
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
9 changes: 9 additions & 0 deletions docs/rtk-query/api/createApi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -938,6 +938,15 @@ _(optional, not applicable with `queryFn`)_

[summary](docblock://query/endpointDefinitions.ts?token=EndpointDefinitionWithQuery.rawErrorResponseSchema)

Use `rawErrorResponseSchema` to validate the error value returned by your `baseQuery` **before** `transformErrorResponse` runs.

This is the error-side equivalent of `rawResponseSchema`. If you want to validate the final value that your endpoint exposes after `transformErrorResponse`, use [`errorResponseSchema`](#errorresponseschema) instead.

In practice:

- `rawErrorResponseSchema` validates the original error shape returned from the server or `baseQuery`
- `errorResponseSchema` validates the transformed error shape that ends up in RTK Query's cache and hooks

[examples](docblock://query/endpointDefinitions.ts?token=EndpointDefinitionWithQuery.rawErrorResponseSchema)

#### `metaSchema`
Expand Down
Loading