At a glance

Elysia is an ergonomic web framework for building backend servers with Bun.

Designed with simplicity and type-safety in mind, Elysia offers a familiar API with extensive support for TypeScript and is optimized for Bun.

Here's a simple hello world in Elysia.

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/', 'Hello Elysia')
    .get
('/user/:id', ({ params
: { id
 }}) => id
)
    .post
('/form', ({ body
 }) => body
)
    .listen
(3000)

Navigate to localhost:3000 and you should see 'Hello Elysia' as the result.

TIP

Hover over the code snippet to see the type definition.

In the mock browser, click on the path highlighted in blue to change paths and preview the response.

Elysia can run in the browser, and the results you see are actually executed using Elysia.

Performance

Building on Bun and extensive optimization like static code analysis allows Elysia to generate optimized code on the fly.

Elysia can outperform most web frameworks available today^[1], and even match the performance of Golang and Rust frameworks^[2].

Framework	Runtime	Average	Plain Text	Dynamic Parameters	JSON Body
bun	bun	262,660.433	326,375.76	237,083.18	224,522.36
elysia	bun	255,574.717	313,073.64	241,891.57	211,758.94
hyper-express	node	234,395.837	311,775.43	249,675	141,737.08
hono	bun	203,937.883	239,229.82	201,663.43	170,920.4
h3	node	96,515.027	114,971.87	87,935.94	86,637.27
oak	deno	46,569.853	55,174.24	48,260.36	36,274.96
fastify	bun	65,897.043	92,856.71	81,604.66	23,229.76
fastify	node	60,322.413	71,150.57	62,060.26	47,756.41
koa	node	39,594.14	46,219.64	40,961.72	31,601.06
express	bun	29,715.537	39,455.46	34,700.85	14,990.3
express	node	15,913.153	17,736.92	17,128.7	12,873.84

TypeScript

Elysia is designed to help you write less TypeScript.

Elysia's Type System is fine-tuned to infer types from your code automatically, without needing to write explicit TypeScript, while providing type-safety at both runtime and compile time for the most ergonomic developer experience.

Take a look at this example:

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/user/:id', ({ params
: { id
 } }) => id
)
    .listen
(3000)

The above code creates a path parameter "id". The value that replaces :id will be passed to params.id both at runtime and in types, without manual type declaration.

123

Elysia's goal is to help you write less TypeScript and focus more on business logic. Let the framework handle the complex types.

TypeScript is not required to use Elysia, but it's recommended.

Type Integrity

To take it a step further, Elysia provides Elysia.t, a schema builder to validate types and values at both runtime and compile time, creating a single source of truth for your data types.

Let's modify the previous code to accept only a number value instead of a string.

typescript

import { Elysia
, t
 } from 'elysia'

new Elysia
()
    .get
('/user/:id', ({ params
: { id
 } }) => id
, {
        params
: t
.Object
({
            id
: t
.Number
()
        })
    })
    .listen
(3000)

This code ensures that our path parameter id will always be a number at both runtime and compile time (type-level).

TIP

Hover over "id" in the above code snippet to see a type definition.

With Elysia's schema builder, we can ensure type safety like a strongly typed language with a single source of truth.

Standard Schema

Elysia supports Standard Schema, allowing you to use your favorite validation library:

Zod
Valibot
ArkType
Effect Schema
Yup
Joi
and more

typescript

import { Elysia
 } from 'elysia'
import { z
 } from 'zod'
import * as v
 from 'valibot'

new Elysia
()
	.get
('/id/:id', ({ params
: { id
 }, query
: { name
 } }) => id
, {
		params
: z
.object
({
			id
: z
.coerce
.number
()
		}),
		query
: v
.object
({
			name
: v
.literal
('Lilith')
		})
	})
	.listen
(3000)

Elysia will infer the types from the schema automatically, allowing you to use your favorite validation library while still maintaining type safety.

OpenAPI

Elysia adopts many standards by default, like OpenAPI, WinterTC compliance, and Standard Schema. Allowing you to integrate with most of the industry standard tools or at least easily integrate with tools you are familiar with.

For instance, because Elysia adopts OpenAPI by default, generating API documentation is as easy as adding a one-liner:

typescript

import { Elysia, t } from 'elysia'
import { openapi } from '@elysiajs/openapi'

new Elysia()
    .use(openapi()) 
    .get('/user/:id', ({ params: { id } }) => id, {
        params: t.Object({
            id: t.Number()
        })
    })
    .listen(3000)

With the OpenAPI plugin, you can seamlessly generate an API documentation page without additional code or specific configuration and share it with your team effortlessly.

OpenAPI from types

Elysia has excellent support for OpenAPI with schemas that can be used for data validation, type inference, and OpenAPI annotation from a single source of truth.

Elysia also supports OpenAPI schema generation with 1 line directly from types, allowing you to have complete and accurate API documentation without any manual annotation.

typescript

import { Elysia, t } from 'elysia'
import { openapi } from '@elysiajs/oepnapi'
import { fromTypes } from '@elysiajs/openapi/gen'

export const app = new Elysia()
    .use(openapi({
    	references: fromTypes('src/index.ts') 
    }))
    .get('/user/:id', ({ params: { id } }) => id, {
        params: t.Object({
            id: t.Number()
        })
    })
    .listen(3000)

End-to-end Type Safety

With Elysia, type safety is not limited to server-side.

With Elysia, you can synchronize your types with your frontend team automatically, similar to tRPC, using Elysia's client library, "Eden".

typescript

import { Elysia
, t
 } from 'elysia'
import { openapi
 } from '@elysiajs/openapi'
import { fromTypes
 } from '@elysiajs/openapi/gen'

export const app
 = new Elysia
()
    .use
(openapi
({
    	references
: fromTypes
('src/index.ts')
    }))
    .get
('/user/:id', ({ params
: { id
 } }) => id
, {
        params
: t
.Object
({
            id
: t
.Number
()
        })
    })
    .listen
(3000)

export type App
 = typeof app

And on your client-side:

typescript

// client.ts
import { treaty
 } from '@elysiajs/eden'
import type { App
 } from './server'

const app
 = treaty
<App
>('localhost:3000')

// Get data from /user/617
const { data
 } = await app
.user
({ id
: 617 }).get
()

console
.log
(data
)

With Eden, you can use the existing Elysia types to query an Elysia server without code generation and synchronize types for both frontend and backend automatically.

Elysia is not only about helping you create a confident backend but for all that is beautiful in this world.

Platform Agnostic

Elysia was designed for Bun, but is not limited to Bun. Being WinterTC compliant allows you to deploy Elysia servers on Cloudflare Workers, Vercel Edge Functions, and most other runtimes that support Web Standard Requests.

Our Community

If you have questions or get stuck with Elysia, feel free to ask our community on GitHub Discussions, Discord, or Twitter.

1. Measured in requests/second. The benchmark for parsing query, path parameter and set response header on Debian 11, Intel i7-13700K tested on Bun 0.7.2 on 6 Aug 2023. See the benchmark condition here.

2. Based on TechEmpower Benchmark round 22.

Tutorial

Our Sponsors

At a glance

Performance

TypeScript

Type Integrity

Standard Schema

OpenAPI

OpenAPI from types

End-to-end Type Safety

Platform Agnostic

Our Community

Our Sponsors

At a glance ​

Performance ​

TypeScript ​

Type Integrity ​

Standard Schema ​

OpenAPI ​

OpenAPI from types ​

End-to-end Type Safety ​

Platform Agnostic ​

Our Community ​

At a glance

Performance

TypeScript

Type Integrity

Standard Schema

OpenAPI

OpenAPI from types

End-to-end Type Safety

Platform Agnostic

Our Community