Skip to content

docs: update right colored diffs #596

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

Merged
merged 4 commits into from
Sep 24, 2025
Merged

docs: update right colored diffs #596

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ea5e17
docs: update right colored diffs
DaxServer Aug 8, 2025
da25393
docs: correct the rest of the code blocks
DaxServer Aug 8, 2025
10e47cf
docs: correct syntax errors
DaxServer Aug 8, 2025
3976108
Merge branch 'main' into patch-1
DaxServer Sep 24, 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
39 changes: 18 additions & 21 deletions docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ import { Elysia, t } from 'elysia'
class Note {
constructor(public data: string[] = ['Moonhalo']) {}

add(note: string) {// [!code ++]
add(note: string) { // [!code ++]
this.data.push(note) // [!code ++]
// [!code ++]
return this.data // [!code ++]
Expand Down Expand Up @@ -764,7 +764,7 @@ Let's create a `user.ts` file that will handle the user authentication:

```typescript [user.ts]
import { Elysia, t } from 'elysia' // [!code ++]
// [!code ++]
// [!code ++]
export const user = new Elysia({ prefix: '/user' }) // [!code ++]
.state({ // [!code ++]
user: {} as Record<string, string>, // [!code ++]
Expand All @@ -778,9 +778,9 @@ export const user = new Elysia({ prefix: '/user' }) // [!code ++]
success: false, // [!code ++]
message: 'User already exists' // [!code ++]
}) // [!code ++]
// [!code ++]
// [!code ++]
store.user[username] = await Bun.password.hash(password) // [!code ++]
// [!code ++]
// [!code ++]
return { // [!code ++]
success: true, // [!code ++]
message: 'User created' // [!code ++]
Expand Down Expand Up @@ -819,8 +819,7 @@ export const user = new Elysia({ prefix: '/user' }) // [!code ++]
message: `Signed in as ${username}` // [!code ++]
} // [!code ++]
}, // [!code ++]
{ // [!code ++]
// [!code ++]
{ // [!code ++]
body: t.Object({ // [!code ++]
username: t.String({ minLength: 1 }), // [!code ++]
password: t.String({ minLength: 8 }) // [!code ++]
Expand All @@ -830,7 +829,6 @@ export const user = new Elysia({ prefix: '/user' }) // [!code ++]
token: t.Number() // [!code ++]
}, // [!code ++]
{ // [!code ++]
// [!code ++]
secrets: 'seia' // [!code ++]
} // [!code ++]
) // [!code ++]
Expand Down Expand Up @@ -912,9 +910,9 @@ export const user = new Elysia({ prefix: '/user' })
message: 'User created'
}
},
{
{ // [!code ++]
body: 'signIn' // [!code ++]
}
} // [!code ++]
)
.post(
'/sign-in',
Expand Down Expand Up @@ -942,10 +940,10 @@ export const user = new Elysia({ prefix: '/user' })
message: `Signed in as ${username}`
}
},
{
{ // [!code ++]
body: 'signIn', // [!code ++]
cookie: 'session' // [!code ++]
}
} // [!code ++]
)
```

Expand Down Expand Up @@ -1043,7 +1041,7 @@ export const user = new Elysia({ prefix: '/user' })
'/sign-out', // [!code ++]
({ cookie: { token } }) => { // [!code ++]
token.remove() // [!code ++]
// [!code ++]
// [!code ++]
return { // [!code ++]
success: true, // [!code ++]
message: 'Signed out' // [!code ++]
Expand All @@ -1057,15 +1055,14 @@ export const user = new Elysia({ prefix: '/user' })
'/profile', // [!code ++]
({ cookie: { token }, store: { session }, status }) => { // [!code ++]
const username = session[token.value] // [!code ++]
// [!code ++]
// [!code ++]
if (!username) // [!code ++]
return status(401, { // [!code ++]
success: false, // [!code ++]
message: 'Unauthorized' // [!code ++]
}) // [!code ++]
// [!code ++]
return {
// [!code ++]
// [!code ++]
return { // [!code ++]
success: true, // [!code ++]
username // [!code ++]
} // [!code ++]
Expand Down Expand Up @@ -1354,8 +1351,8 @@ export const note = new Elysia({ prefix: '/note' })
note.add({ data, author: username }),
{ // [!code ++]
body: 'memo' // [!code ++]
}
) // [!code ++]
} // [!code ++]
)
.guard({
params: t.Object({
index: t.Number()
Expand All @@ -1381,15 +1378,15 @@ export const note = new Elysia({ prefix: '/note' })
if (index in note.data) return note.update(index, data) // [!code --]
({ note, params: { index }, body: { data }, status, username }) => { // [!code ++]
if (index in note.data) // [!code ++]
return note.update(index, { data, author: username })) // [!code ++]
return note.update(index, { data, author: username }) // [!code ++]

return status(422)
},
{
body: t.Object({ // [!code --]
data: t.String() // [!code --]
}), // [!code --]
body: 'memo'
body: 'memo' // [!code ++]
}
)
```
Expand Down Expand Up @@ -1584,7 +1581,7 @@ Now let's apply the OpenTelemetry plugin to our server.
::: code-group

```typescript [index.ts]
import { Elysia, t } from 'elysia'
import { Elysia } from 'elysia'
import { opentelemetry } from '@elysiajs/opentelemetry' // [!code ++]
import { openapi } from '@elysiajs/openapi'

Expand Down