响应
调用 fetch 方法后,Eden Treaty 返回一个 Promise,其中包含以下属性:
- data - 响应的返回值(2xx)
- error - 响应的返回值(>= 3xx)
- response
Response
- Web 标准响应类 - status
number
- HTTP 状态码 - headers
FetchRequestInit['headers']
- 响应头
返回后,您必须提供错误处理,以确保响应数据值被解包,否则该值将为可空。Elysia 提供了一个 error()
辅助函数来处理错误,Eden 将提供错误值的类型收窄。
typescript
import { Elysia, t } from 'elysia'
import { treaty } from '@elysiajs/eden'
const app = new Elysia()
.post('/user', ({ body: { name }, error }) => {
if(name === 'Otto')
return error(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
})
// type: string | null
console.log(data)
if (error)
switch(error.status) {
case 400:
// 错误类型将被收窄
throw error.value
default:
throw error.value
}
// 一旦错误被处理,类型将被解包
// type: string
return data
}
默认情况下,Elysia 会自动推断 error
和 response
的类型为 TypeScript,而 Eden 将提供自动完成和类型收窄以确保准确的行为。
TIP
如果服务器的响应 HTTP 状态 >= 300,则值将始终为 null,而 error
将有一个返回值。
否则,响应将传递给 data。
流响应
Eden 将视流响应为 AsyncGenerator
,允许我们使用 for await
循环来消费流。
typescript
import { Elysia } from 'elysia'
import { treaty } from '@elysiajs/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)