Grouping Routes

When creating a web server, you would often have multiple routes sharing the same prefix:

import { Elysia } from 'elysia'

new Elysia()
    .post('/user/sign-in', () => 'Sign in')
    .post('/user/sign-up', () => 'Sign up')
    .post('/user/profile', () => 'Profile')
    .listen(3000)

localhost/user/sign-in/user/sign-up/user/profile

POST

This can be improved with Elysia.group, allowing us to apply prefixes to multiple routes at the same time by grouping them together:

import { Elysia } from 'elysia'

new Elysia()
    .group('/user', (app) =>
        app
            .post('/sign-in', () => 'Sign in')
            .post('/sign-up', () => 'Sign up')
            .post('/profile', () => 'Profile')
    )
    .listen(3000)

localhost/user/sign-in/user/sign-up/user/profile

POST

This code behaves the same as our first example and should be structured as follows:

Path	Result
/user/sign-in	Sign in
/user/sign-up	Sign up
/user/profile	Profile

.group() can also accept an optional guard parameter to reduce boilerplate of using groups and guards together:

import { Elysia, t } from 'elysia'

new Elysia()
    .group(
        '/user', 
        { 
            body: t.Literal('Rikuhachima Aru')
        },
        (app) => app
            .post('/sign-in', () => 'Sign in')
            .post('/sign-up', () => 'Sign up')
            .post('/profile', () => 'Profile')
    )
    .listen(3000)

You may find more information about grouped guards in scope.

Prefixing

We can separate a group into a separate plugin instance to reduce nesting by providing a prefix to the constructor.

import { Elysia } from 'elysia'

const users = new Elysia({ prefix: '/user' })
    .post('/sign-in', () => 'Sign in')
    .post('/sign-up', () => 'Sign up')
    .post('/profile', () => 'Profile')

new Elysia()
    .use(users)
    .get('/', () => 'hello world')
    .listen(3000)

localhost//user/sign-in/user/sign-up/user/profile

GET