elysiajs

Files (53)

• SKILL.md
• basic.ts · examples/
• body-parser.ts · examples/
• complex.ts · examples/
• cookie.ts · examples/
• error.ts · examples/
• file.ts · examples/
• guard.ts · examples/
• map-response.ts · examples/
• redirect.ts · examples/
• rename.ts · examples/
• schema.ts · examples/
• state.ts · examples/
• upload-file.ts · examples/
• websocket.ts · examples/
• ai-sdk.md · integrations/
• astro.md · integrations/
• better-auth.md · integrations/
• cloudflare-worker.md · integrations/
• deno.md · integrations/
• drizzle.md · integrations/
• expo.md · integrations/
• nextjs.md · integrations/
• nodejs.md · integrations/
• nuxt.md · integrations/
• prisma.md · integrations/
• react-email.md · integrations/
• sveltekit.md · integrations/
• tanstack-start.md · integrations/
• vercel.md · integrations/
• mvc.md · patterns/
• bearer.md · plugins/
• cors.md · plugins/
• cron.md · plugins/
• graphql-apollo.md · plugins/
• graphql-yoga.md · plugins/
• html.md · plugins/
• jwt.md · plugins/
• openapi.md · plugins/
• opentelemetry.md · plugins/
• server-timing.md · plugins/
• static.md · plugins/
• bun-fullstack-dev-server.md · references/
• cookie.md · references/
• deployment.md · references/
• eden.md · references/
• lifecycle.md · references/
• macro.md · references/
• plugin.md · references/
• route.md · references/
• testing.md · references/
• validation.md · references/
• websocket.md · references/

SKILL.md (first lines)

# ElysiaJS Development Skill

Always consult [elysiajs.com/llms.txt](https://elysiajs.com/llms.txt) for code examples and latest API.

## Overview

ElysiaJS is a TypeScript framework for building Bun-first (but not limited to Bun) type-safe, high-performance backend servers. This skill provides comprehensive guidance for developing with Elysia, including routing, validation, authentication, plugins, integrations, and deployment.

## When to Use This Skill

Trigger this skill when the user asks to:
- Create or modify ElysiaJS routes, handlers, or servers
- Setup validation with TypeBox or other schema libraries (Zod, Valibot)
- Implement authentication (JWT, session-based, macros, guards)
- Add plugins (CORS, OpenAPI, Static files, JWT)
- Integrate with external services (Drizzle ORM, Better Auth, Next.js, Eden Treaty)
- Setup WebSocket endpoints for real-time features
- Create unit tests for Elysia instances
- Deploy Elysia servers to production

## Quick Start
Quick scaffold:
```bash
bun create elysia app
```

### Basic Server
```typescript
import { Elysia, t, status } from 'elysia'

const app = new Elysia()
  	.get('/', () => 'Hello World')
   	.post('/user', ({ body }) => body, {
    	body: t.Object({
      		name: t.String(),
        	age: t.Number()
     	})
    })
    .get('/id/:id', ({ params: { id } }) => {
   		if(id > 1_000_000) return status(404, 'Not Found')
     
     	return id
    }, {
    	params: t.Object({
     		id: t.Number({
       			minimum: 1
       		})
     	}),
     	response: {
      		200: t.Number(),
        	404: t.Literal('Not Found')
      	}
    })
    .listen(3000)
```

## Basic Usage

### HTTP Methods
```typescript
import { Elysia } from 'elysia'

new Elysia()
  .get('/', 'GET')
  .post('/', 'POST')
  .put('/', 'PUT')
  .patch('/', 'PATCH')
  .delete('/', 'DELETE')
  .options('/', 'OPTIONS')
  .head('/', 'HEAD')
```

### Path Parameters
```typescript
.get('/user/:id', ({ params: { id } }) => id)
.get('/post/:id/:slug', ({ params }) => params)
```

### Query Parameters
```typescript
.get('/search', ({ query }) => query.q)
// GET /search?q=elysia → "elysia"
```

### Request Body
```typescript
.post('/user', ({ body }) => body)
```

### Headers
```typescript
.get('/', ({ headers }) => headers.authorization)
```

## TypeBox Validation

### Basic Types
```typescript
import { Elysia, t } from 'elysia'

.post('/user', ({ body }) => body, {
  body: t.Object({
    name: t.String(),
    age: t.Number(),
    email: t.String({ format: 'email' }),
    website: t.Optional(t.String({ format: 'uri' }))
  })
})
```

### Nested Objects
```typescript
body: t.Object({
  user: t.Object({
    name: t.String(),
    address: t.Object({
      street: t.String(),
      city: t.String()
    })

From jralvarenga/better-translate, MIT.

More from jralvarenga/better-translate