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 > 入門 > 錯誤處理。