端到端类型安全 Interactive Playground

想象一下你有一个玩具火车套件。

每一段火车轨道都必须完美契合下一段，就像拼图一样。

对于一个框架来说，具备端到端类型安全意味着你可以以类型安全的方式连接客户端和服务器。

Elysia 提供了开箱即用的端到端类型安全 无需代码生成，通过类似 RPC 的连接器 Eden 实现。

支持 e2e 类型安全的其他框架：

tRPC
Remix
SvelteKit
Nuxt
TS-Rest

Elysia 允许你在服务器端更改类型，客户端将立即反映这些更改，有助于自动补全和类型强制。

Eden

Eden 是一个类似 RPC 的客户端，旨在仅利用 TypeScript 的类型推断连接 Elysia，实现端到端类型安全，无需代码生成。

Eden 由两个模块组成：

Eden Treaty （推荐）：Eden Treaty 1（edenTreaty）的改进版 RPC
Eden Fetch：具有类型安全的类似 fetch 的客户端

下面是每个模块的概述、用例和比较。

使用 Eden Treaty，我们能以完整类型支持和自动补全、类型范围缩小的错误处理与类型安全的单元测试方式与 Elysia 服务器交互。

typescript

// @filename: server.ts
import { Elysia, t } from 'elysia'

const app = new Elysia()
    .get('/', 'hi')
    .get('/users', () => 'Skadi')
    .put('/nendoroid/:id', ({ body }) => body, {
        body: t.Object({
            name: t.String(),
            from: t.String()
        })
    })
    .get('/nendoroid/:id/name', () => 'Skadi')
    .listen(3000)

export type App = typeof app

// @filename: index.ts
// ---cut---
import { treaty } from '@elysia/eden'
import type { App } from './server'

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

// @noErrors
app.
//  ^|


// 调用 [GET] 在 '/'
const { data } = await app.get()

// 调用 [PUT] 在 '/nendoroid/:id'
const { data: nendoroid, error } = await app.nendoroid({ id: 1895 }).put({
    name: 'Skadi',
    from: 'Arknights'
})

Eden Fetch

为偏好 fetch 语法的开发者提供的类似 fetch 的 Eden Treaty 替代方案。

typescript

import { edenFetch } from '@elysia/eden'
import type { App } from './server'

const fetch = edenFetch<App>('http://localhost:3000')

const { data } = await fetch('/name/:name', {
    method: 'POST',
    params: {
        name: 'Saori'
    },
    body: {
        branch: 'Arius',
        type: 'Striker'
    }
})

NOTE

与 Eden Treaty 不同，Eden Fetch 不提供 Elysia 服务器的 WebSocket 实现。

端到端类型安全 Interactive Playground ​

Eden ​

Eden Fetch ​

端到端类型安全 Interactive Playground

Eden

Eden Fetch