Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Enhance middleware documentation with error handling details #6499

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

Enhance middleware documentation with error handling details #6499

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1ce757
Enhance middleware documentation with error handling details
Bryson14 Jan 25, 2026
3712167
Update middleware.md for error handling and async user fetch
Bryson14 Jan 25, 2026
344151c
Fix formatting issues in middleware documentation
Bryson14 Jan 25, 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
22 changes: 22 additions & 0 deletions docs/start/framework/react/guide/middleware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,28 @@ const loggingMiddleware = createMiddleware().server(async ({ next }) => {
})
```

The exception to always returning `next()` is throwing errors. By default, throwing an error will cause the router to short-circuit and return the data passed into the `Error` as a 500 HTTP error-code response. If you want to return another error code, like with an authentication middleware, you can throw the `json` helper.

```tsx
import { createMiddleware, json } from "@tanstack/react-start";

const authMiddleware = createMiddleware().server(async ({ next, request }) => {
const client = await getMyDb();
if (!client) {
throw new Error("Oh No!"); // returns a 500 HTTP response to the client
}
const sessionCookie = request.headers.get("Authorization");
const user = await client.getUser(sessionCookie);
if (!user) {
throw json({
message: "you shall not pass!"
}, {status: 401})
}

return await next({ context: { user }}) // pass the user's information to the next middlware or server function
})
```

## Request Middleware

Request middleware is used to customize the behavior of any server request that passes through it, including server routes, SSR and server functions.
Expand Down