错误处理

onError抛出错误 时被调用。

它接受类似于处理程序的 context,但包括额外的内容:

  • error - 抛出的错误
  • code - 错误代码
typescript
import { Elysia } from 'elysia'

new Elysia()
	.onError(({ code, status }) => {
		if(code === "NOT_FOUND")
			return '呃~ 你迷路了吗?'

		return status(418, "我错了!但我可爱,所以你会原谅我,对吧?")
	})
	.get('/', () => 'ok')
	.listen(3000)

您可以返回一个 status 来覆盖默认的错误状态。

自定义错误

您可以如下提供带有 错误代码 的自定义错误:

typescript
import { Elysia } from 'elysia'

class NicheError extends Error {
	constructor(message: string) {
		super(message)
	}
}

new Elysia()
	.error({ 
		'NICHE': NicheError 
	}) 
	.onError(({ error, code, status }) => {
		if(code === 'NICHE') {
			// 类型为 NicheError
			console.log(error)

			return status(418, "我们不知道你是怎么来到这里的")
		}
	})
	.get('/', () => {
		throw new NicheError('自定义错误消息')
	})
	.listen(3000)

Elysia 使用 错误代码 来缩小错误类型的范围。

建议注册自定义错误,因为 Elysia 可以缩小类型范围。

错误状态代码

您还可以通过向类添加 status 属性来提供自定义状态代码:

typescript
import { Elysia } from 'elysia'

class NicheError extends Error {
	status = 418

	constructor(message: string) {
		super(message)
	}
}

如果抛出错误,Elysia 将使用此状态代码,详情请参见 自定义状态代码

错误响应

您还可以通过提供 toResponse 方法直接在错误中定义自定义错误响应:

typescript
import { Elysia } from 'elysia'

class NicheError extends Error {
	status = 418

	constructor(message: string) {
		super(message)
	}

	toResponse() { 
		return { message: this.message } 
	} 
}

如果抛出错误,Elysia 将使用此响应,详情请参见 自定义错误响应

练习

我们尝试扩展 Elysia 的上下文。

  1. Your own 404

    Let's override a default 404 response your own

  2. Your Custom Error

    Let's define your own custom error, throw it in GET "/" endpoint, and return a status 418

Show answer
1. 你可以通过 "NOT_FOUND" 来缩小错误范围,以覆盖 404 响应。 2. 使用带有 status 属性(418)的自定义错误传递给 `.error()` 方法。
typescript
import { Elysia } from 'elysia'

class YourError extends Error {
	status = 418

	constructor(message: string) {
		super(message)
	}
}

new Elysia()
	.error({
		"YOUR_ERROR": YourError
	})
	.onError(({ code, status }) => {
		if(code === "NOT_FOUND")
			return "嗨,你好"
	})
	.get('/', () => {
		throw new YourError("A")
	})
	.listen(3000)
  • index.ts