useEventSource
An EventSource or Server-Sent-Events instance opens a persistent connection to an HTTP server, which sends events in text/event-stream format.
Package: @vueuse/core
Category: Network
Usage
import { useEventSource } from '@vueuse/core'
const { status, data, error, close } = useEventSource('https://event-source-url')Options
| Option | Type | Default | Description |
|---|---|---|---|
| autoReconnect | boolean | { |
false | Enabled auto reconnect |
| retries | number | (() => boolean) |
-1 | Maximum retry times. |
| delay | number |
1000 | Delay for reconnect, in milliseconds |
| onFailed | Fn |
- | On maximum retry times reached. |
Returns
| Name | Type |
|---|---|
| eventSource | shallowRef<EventSource | null> |
| event | Ref |
| data | Ref |
| status | shallowRef<EventSourceStatus> |
| error | shallowRef<Event | null> |
| open | Ref |
| close | Ref |
| lastEventId | shallowRef<string | null> |