Skip to content

Commit

Permalink
docs: add useError composable (#8912)
Browse files Browse the repository at this point in the history
  • Loading branch information
Krutie committed Feb 4, 2023
1 parent 78a0adf commit 217e59a
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions docs/3.api/1.composables/use-error.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,37 @@
---
title: "useError"
description: useError composable returns the global Nuxt error that is being handled.
---

# `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
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"}
::

0 comments on commit 217e59a

Please sign in to comment.