Skip to content

docs: show string status names in lifecycle and error handling #740

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

Closed
braden-w wants to merge 3 commits into from
Closed

docs: show string status names in lifecycle and error handling #740

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
f960ccc
docs(essential): clarify status accepts both number and string names
braden-w Dec 5, 2025
2d2207c
style: use single quotes for status strings
Dec 6, 2025
ca95968
style: use double quotes for strings with apostrophes
Dec 6, 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
4 changes: 2 additions & 2 deletions docs/essential/life-cycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ import { validateSession } from './user'
new Elysia()
.get('/', () => 'hi', {
beforeHandle({ set, cookie: { session }, status }) {
if (!validateSession(session.value)) return status(401)
if (!validateSession(session.value)) return status('Unauthorized')
}
})
.listen(3000)
Expand All @@ -527,7 +527,7 @@ new Elysia()
.guard(
{
beforeHandle({ set, cookie: { session }, status }) {
if (!validateSession(session.value)) return status(401)
if (!validateSession(session.value)) return status('Unauthorized')
}
},
(app) =>
Expand Down
2 changes: 2 additions & 0 deletions docs/patterns/error-handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ new Elysia()
})
```

Here we use `status(418)` which is the "I'm a teapot" status code. You can also use the string name directly: `status("I'm a teapot")`. See [Status and Headers](/tutorial/getting-started/status-and-headers) for more on using status codes.

<Playground
:elysia="demo"
/>