createError

源文件
创建一个包含额外元数据的错误对象。

您可以使用此函数创建带有额外元数据的错误对象。它可以在应用程序的 Vue 和 Nitro 部分使用，旨在被抛出。

参数

  • err: string | { cause, data, message, name, stack, statusCode, statusMessage, fatal }

您可以向 createError 函数传递字符串或对象。如果传递字符串，它将用作错误 message，并且 statusCode 将默认为 500。如果传递对象，您可以设置错误的多个属性，例如 statusCode、message 和其他错误属性。

在 Vue 应用中

如果您抛出使用 createError 创建的错误

  • 在服务器端，它将触发一个全屏错误页面，您可以使用 clearError 清除。
  • 在客户端，它将抛出一个非致命错误供您处理。如果您需要触发全屏错误页面，则可以通过设置 fatal: true 来实现。

示例

app/pages/movies/[slug].vue
<script setup lang="ts">
const route = useRoute()
const { data } = await useFetch(`/api/movies/${route.params.slug}`)
if (!data.value) {
  throw createError({ statusCode: 404, statusMessage: 'Page Not Found' })
}
</script>

在 API 路由中

使用 createError 在服务器 API 路由中触发错误处理。

示例

server/api/error.ts
export default eventHandler(() => {
  throw createError({
    statusCode: 404,
    statusMessage: 'Page Not Found',
  })
})

在 API 路由中，建议使用 createError 并传递一个带有简短 statusMessage 的对象，因为这样可以在客户端访问。否则，API 路由上传递给 createError 的 message 不会传播到客户端。或者，您可以使用 data 属性将数据传递回客户端。无论如何，请始终考虑避免将动态用户输入放入消息中，以避免潜在的安全问题。

阅读更多内容请参见 文档 > 4 X > 入门 > 错误处理。