createError

You can use this function to create an error object with additional metadata. It is usable in both the Vue and Nitro portions of your app, and is meant to be thrown.

Parameters:

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

Throwing Errors in Your Vue App

If you throw an error created withcreateError:

• on server-side, it will trigger a full-screen error page which you can clear withclearError.
• on client-side, it will throw a non-fatal error for you to handle. If you need to trigger a full-screen error page, then you can do this by settingfatal: true.

Example

<scriptsetuplang="ts">constroute=useRoute()const {data }=awaituseFetch(`/api/movies/${route.params.slug}`)if (!data.value) {throwcreateError({statusCode:404,statusMessage:'Page Not Found' })}</script>

Throwing Errors in API Routes

UsecreateError to trigger error handling in server API routes.

Example

exportdefaulteventHandler(()=> {throwcreateError({statusCode:404,statusMessage:'Page Not Found'  })})