Nuxt/docs/content/3.api/3.utils/show-error.md
Daniel Roe 78618f1f21
feat(nuxt): improve error dx for users (#4539)
Co-authored-by: Pooya Parsa <pooya@pi0.io>
2022-07-21 16:29:03 +02:00

22 lines
686 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 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="/guide/features/error-handling"}
::