DEV Community

Cover image for Introducing ElysiaJS: A Professional Web Framework
Anil K Tiwari
Anil K Tiwari

Posted on • Updated on

Introducing ElysiaJS: A Professional Web Framework

In the ever-evolving landscape of web development, it's essential to choose the right tools for your projects. ElysiaJS, pronounced as "eh-LIHZ-iy-ah" (エリシア・เอลิเซีย), is a fast and friendly web framework that stands out from the crowd. Built on a foundation of three core philosophies – Performance, Simplicity, and Flexibility – ElysiaJS is designed with TypeScript in mind, making it a powerful choice for developers of all backgrounds

The Three Pillars of ElysiaJS

1. Performance
With ElysiaJS, you won't need to worry about the underlying performance of your web applications. It's designed to handle the heavy lifting, allowing you to focus on creating outstanding user experiences.

2. Simplicity
ElysiaJS provides simple building blocks that allow you to create abstractions without repeating yourself. This means you can write clean and concise code that's easy to maintain.

3. Flexibility
One of ElysiaJS's standout features is its flexibility. You have the power to customize most of the library to fit your specific needs. This adaptability ensures that ElysiaJS can be tailored to a wide range of projects.


TypeScript Integration
ElysiaJS seamlessly integrates with TypeScript, but you don't need to be a TypeScript expert to harness its power. The library understands your intentions and automatically infers types from your code, simplifying development and enhancing type safety.

A Glimpse of TypeScript Integration

new Elysia()
  .get('/id/:id', (({ params: { id }}) => id))
  .listen(8080)
Enter fullscreen mode Exit fullscreen mode

ElysiaJS intelligently deduces that you want to use "id" as a path parameter and registers it as a type in "params."

Type-Safe Request Handling
You can define custom types for various aspects of your application, such as incoming request bodies. This level of control allows you to explicitly specify the expected structure of request data and ensure type safety.
Example of Type-Safe Request Handling

import { Elysia, t } from 'elysia'

new Elysia()
  .post('/sign-in', ({ body }) => signIn(body), {
    body: t.Object({ username: t.String(), password: t.String() })
  })
  .listen(8080)
Enter fullscreen mode Exit fullscreen mode

Here, ElysiaJS validates incoming request bodies based on the defined structure, guaranteeing type safety.


Instant API Documentation with Swagger
ElysiaJS simplifies API documentation generation with just a single line of code. By incorporating plugins like Swagger, you can effortlessly create comprehensive API documentation for your projects.
Generating API Documentation with Swagger

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

new Elysia()
  .use(swagger())
  .post('/sign-in', ({ body }) => signIn(body), {
    body: t.Object({ username: t.String(), password: t.String() })
  })
  .listen(8080)

Enter fullscreen mode Exit fullscreen mode

Type-Safe Client Creation with Eden

ElysiaJS takes type safety to the next level by enabling you to create fully type-safe clients for consuming Elysia APIs. This ensures a single source of truth for your data structure, eliminating type conflicts between TypeScript, actual requests, API documentation, and frontend clients.
Type-Safe Client with Eden

// server.ts
import { Elysia, t } from 'elysia'
import { swagger } from '@elysiajs/swagger'

const app = new Elysia()
  .use(swagger())
  .post('/sign-in', ({ body }) => signIn(body), {
    body: t.Object({ username: t.String(), password: t.String() })
  })
  .listen(8080)

export type App = typeof app
Enter fullscreen mode Exit fullscreen mode
// client.ts
import { edenTreaty } from '@elysiajs/eden'
import type { App } from './server'

const app = edenTreaty<App>('http://localhost:8080')

app.signIn.post({ username: 'saltyaom', password: 12345678 }).then(console.log)

Enter fullscreen mode Exit fullscreen mode

Conclusion

ElysiaJS is not just another web framework; it's a powerful ally in your web development journey. With its focus on performance, simplicity, and flexibility, seamless TypeScript integration, type-safe request handling, Swagger integration for API documentation, and Eden for type-safe client creation, ElysiaJS empowers you to build robust, efficient, and maintainable web applications. Say goodbye to type conflicts and development headaches – ElysiaJS has got you covered.

Ready to embark on your ElysiaJS adventure? Explore the possibilities, eliminate uncertainty, and elevate your web development projects with ElysiaJS today!

Top comments (0)