useEventSource

Usage

import { useEventSource } from '@vueuse/core'

const { status, data, error, close } = useEventSource('https://event-source-url')

import { useEventSource } from '@vueuse/core'

const { status, data, error, close } = useEventSource('https://event-source-url')

State	Type	Description
status	`Ref<string>`	A read-only value representing the state of the connection. Possible values are CONNECTING (0), OPEN (1), or CLOSED (2)
data	`Ref<string \| null>`	Reference to the latest data received via the EventSource, can be watched to respond to incoming messages
eventSource	`Ref<EventSource \| null>`	Reference to the current EventSource instance

Method	Signature	Description
close	`() => void`	Closes the EventSource connection gracefully.

Type Declarations

typescript

export declare type UseEventSourceOptions = EventSourceInit
/**
 * Reactive wrapper for EventSource.
 *
 * @see https://vueuse.org/useEventSource
 * @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource EventSource
 * @param url
 * @param events
 * @param options
 */
export declare function useEventSource(
  url: string,
  events?: Array<string>,
  options?: UseEventSourceOptions
): {
  eventSource: Ref<EventSource | null>
  event: Ref<string | null>
  data: Ref<string | null>
  status: Ref<"OPEN" | "CONNECTING" | "CLOSED">
  error: Ref<Event | null>
  close: () => void
}
export declare type UseEventSourceReturn = ReturnType<typeof useEventSource>

export declare type UseEventSourceOptions = EventSourceInit
/**
 * Reactive wrapper for EventSource.
 *
 * @see https://vueuse.org/useEventSource
 * @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource EventSource
 * @param url
 * @param events
 * @param options
 */
export declare function useEventSource(
  url: string,
  events?: Array<string>,
  options?: UseEventSourceOptions
): {
  eventSource: Ref<EventSource | null>
  event: Ref<string | null>
  data: Ref<string | null>
  status: Ref<"OPEN" | "CONNECTING" | "CLOSED">
  error: Ref<Event | null>
  close: () => void
}
export declare type UseEventSourceReturn = ReturnType<typeof useEventSource>