Nuxt/docs/content/3.api/3.utils/show-error.md
Clément Ollivier 944bba97ca
docs: update structure (#7047)
Co-authored-by: Pooya Parsa <pooya@pi0.io>
2022-09-13 14:54:31 +02:00

22 lines
681 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()`](/api/composables/use-error) to create a reactive and SSR-friendly shared error state across components.
`showError` calls the `app:error` hook.
::ReadMore{link="/getting-started/error-handling"}
::