mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-26 15:42:09 +00:00
32 lines
925 B
Markdown
32 lines
925 B
Markdown
---
|
|
title: 'showError'
|
|
description: Nuxt provides a quick and simple way to show a full screen error page if needed.
|
|
links:
|
|
- label: Source
|
|
icon: i-simple-icons-github
|
|
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/error.ts
|
|
size: xs
|
|
---
|
|
|
|
Within the [Nuxt context](/docs/guide/going-further/nuxt-app#the-nuxt-context) you can use `showError` to show an error.
|
|
|
|
**Parameters:**
|
|
|
|
- `error`: `string | Error | Partial<{ cause, data, message, name, stack, statusCode, statusMessage }>`
|
|
|
|
```ts
|
|
showError("😱 Oh no, an error has been thrown.")
|
|
showError({
|
|
statusCode: 404,
|
|
statusMessage: "Page Not Found"
|
|
})
|
|
```
|
|
|
|
The error is set in the state using [`useError()`](/docs/api/composables/use-error) to create a reactive and SSR-friendly shared error state across components.
|
|
|
|
::callout
|
|
`showError` calls the `app:error` hook.
|
|
::
|
|
|
|
:read-more{to="/docs/getting-started/error-handling"}
|