Skip to content

docs(tutorial): show string status names in lifecycle examples #739

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 4 commits into from
Closed

docs(tutorial): show string status names in lifecycle examples #739

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8822cdd
docs(tutorial): show string status names in lifecycle examples
braden-w Dec 5, 2025
a41ff8e
docs(tutorial): clarify status accepts both number and string names
braden-w Dec 6, 2025
041d9d1
style: use single quotes for status strings
Dec 6, 2025
0edd016
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: 3 additions & 1 deletion docs/tutorial/getting-started/life-cycle/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ new Elysia()
.get('/2', () => 'Hello 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 <DocLink href="/tutorial/getting-started/status-and-headers">Status and Headers</DocLink> for more on using status codes.

When `beforeHandle` returns a value, it will skip the handler and return the value instead.

This is useful for things like authentication, where you want to return a `401 Unauthorized` response if the user is not authenticated.
Expand Down Expand Up @@ -147,7 +149,7 @@ import { Elysia } from 'elysia'

new Elysia()
.onBeforeHandle(({ query: { name }, status }) => {
if(!name) return status(401)
if(!name) return status('Unauthorized')
})
.get('/auth', ({ query: { name = 'anon' } }) => {
return `Hello ${name}!`
Expand Down