docs: add useError composable (#8912)

This commit is contained in:
Krutie Patel 2023-02-05 00:17:05 +10:00 committed by GitHub
parent 78a0adfd1e
commit 217e59ad96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,12 +1,37 @@
---
title: "useError"
description: useError composable returns the global Nuxt error that is being handled.
---
# `useError` # `useError`
This function will return the global Nuxt error that is being handled. `useError` composable returns the global Nuxt error that is being handled and it is available on both client and server.
```ts ```ts
const error = useError() const error = useError()
``` ```
`useError` sets an error in the state and creates a reactive and SSR-friendly global Nuxt error across components. `useError` sets an error in the state and creates a reactive as well as SSR-friendly global Nuxt error across components. Nuxt errors have the following properties:
## Properties
- **statusCode**
Type: `Number`
HTTP response status code
- **statusMessage**
Type: `String`
HTTP response status message
- **message**
Type: `String`
Error message
::ReadMore{link="/docs/getting-started/error-handling"} ::ReadMore{link="/docs/getting-started/error-handling"}
:: ::