---
url: >-
  https://game-engine-io.github.io/enginex-frontend-sdk/reference/api/@getenginex/sdk-vue/functions/useRealtimeStatus.md
---
[Reference](../../../index.md) / [@getenginex/sdk-vue](../index.md) / useRealtimeStatus

# useRealtimeStatus()

> **useRealtimeStatus**(): `Readonly`<`Ref`<[`RealtimeStatus`](../../sdk/realtime/type-aliases/RealtimeStatus.md)>>

Status of the client's realtime connection (`'connecting'`, `'open'`, `'reconnecting'`, `'closed'` or
`'unavailable'`), reactive. It does not open the connection: it opens with the first [useRealtime](useRealtime.md) or
[useRealtimeSync](useRealtimeSync.md). On the server (SSR) it is `'closed'`.

## Returns

`Readonly`<`Ref`<[`RealtimeStatus`](../../sdk/realtime/type-aliases/RealtimeStatus.md)>>

Read-only ref with the current status.

## Throws

If called in an app without the `EnginexPlugin`.

## Example

```ts
const status = useRealtimeStatus()
const reconnecting = computed(() => status.value === 'reconnecting')
```
