Nuxt/docs/3.api/3.utils/show-error.md
Sébastien Chopin 3ec108493d
docs: simplify the docs directory (#18506)
* docs: simplify docs to only markdown

* Create nuxt-config.md

* chore: update

* chore: add readme
2023-01-25 10:41:41 +01:00

22 lines
691 B
Markdown

# `showError`
Nuxt provides a quick and simple way to show a full screen error page if needed.
Within your pages, components and plugins you can use `showError` to show an error.
**Parameters:**
- `error`: `string | Error | Partial<{ cause, data, message, name, stack, statusCode, statusMessage }>`
```js
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.
`showError` calls the `app:error` hook.
::ReadMore{link="/docs/getting-started/error-handling"}
::