响应

一旦调用 fetch 方法，Eden Treaty 会返回一个包含以下属性的对象的 Promise：

• data - 响应返回的值（2xx）
• error - 响应返回的错误值（>= 3xx）
• response Response - Web 标准的 Response 类
• status number - HTTP 状态码
• headers FetchRequestInit['headers'] - 响应头信息

一旦返回，您必须提供错误处理以确保响应数据值被解包；否则，该值将可能为 null。Elysia 提供了一个 error() 辅助函数来处理错误，而 Eden 会对错误值提供类型收窄。

import { Elysia, t } from 'elysia'
import { treaty } from '@elysia/eden'

const app = new Elysia()
    .post('/user', ({ body: { name }, status }) => {
        if(name === 'Otto') return status(400)

        return name
    }, {
        body: t.Object({
            name: t.String()
        })
    })
    .listen(3000)

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

const submit = async (name: string) => {
    const { data, error } = await api.user.post({
        name
    })

    // 类型: string | null
    console.log(data)

    if (error)
        switch(error.status) {
            case 400:
                // 错误类型将被收窄
                throw error.value

            default:
                throw error.value
        }

    // 一旦错误被处理，类型将被解包
    // 类型: string
    return data
}

默认情况下，Elysia 会自动推断 error 和 response 的类型至 TypeScript，Eden 将提供自动补全和类型收窄以实现准确的行为。

TIP

如果服务器响应的 HTTP 状态码 >= 300，则值始终为 null，而 error 会包含返回的值。

否则，响应值将传递给 data。

流响应

Eden 会将流响应或 服务器发送事件 解释为一个 AsyncGenerator，允许我们使用 for await 循环来消费该流。

流

import { Elysia } from 'elysia'
import { treaty } from '@elysia/eden'

const app = new Elysia()
	.get('/ok', function* () {
		yield 1
		yield 2
		yield 3
	})

const { data, error } = await treaty(app).ok.get()
if (error) throw error

for await (const chunk of data)
	console.log(chunk)
               // ^?

服务器发送事件

import { Elysia, sse } from 'elysia'
import { treaty } from '@elysia/eden'

const app = new Elysia()
	.get('/ok', function* () {
		yield sse({
			event: 'message',
			data: 1
		})
		yield sse({
			event: 'message',
			data: 2
		})
		yield sse({
			event: 'end'
		})
	})

const { data, error } = await treaty(app).ok.get()
if (error) throw error

for await (const chunk of data)
	console.log(chunk)
               // ^?







//

实用类型

Eden Treaty 提供了实用类型 Treaty.Data<T> 和 Treaty.Error<T> 用于提取响应中的 data 和 error 类型。

import { Elysia, t } from 'elysia'

import { treaty, Treaty } from '@elysia/eden'

const app = new Elysia()
	.post('/user', ({ body: { name }, status }) => {
		if(name === 'Otto') return status(400)

		return name
	}, {
		body: t.Object({
			name: t.String()
		})
	})
	.listen(3000)

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

type UserData = Treaty.Data<typeof api.user.post>
//     ^?


// 或者，您也可以传入一个响应对象
const response = await api.user.post({
	name: 'Saltyaom'
})

type UserDataFromResponse = Treaty.Data<typeof response>
//     ^?



type UserError = Treaty.Error<typeof api.user.post>
//     ^?












//