Class SSEServerResponse

constructor

• new SSEServerResponse(): SSEServerResponse

  Create a new SSE server response. The underlying stream is created lazily.

  Returns SSEServerResponse

Readonlystream

closed

• get closed(): boolean

  Whether the underlying stream has been closed.

  Returns boolean

comment

• comment(text?: string): this

  Send a comment (heartbeat ping).

  Parameters

  • text: string = ""

  Returns this

send

• send(data: string, options?: { id?: string; retry?: number }): this

  Send a "message" event.

  Parameters

  • data: string
  • options: { id?: string; retry?: number } = {}

  Returns this

sendEvent

• sendEvent(
      event: string,
      data: string,
      options?: { id?: string; retry?: number },
  ): this

  Send a named event.

  Parameters

  • event: string
  • data: string
  • options: { id?: string; retry?: number } = {}

  Returns this

sendJSON

• sendJSON<T>(event: string, data: T, options?: { id?: string }): this

  Send a typed JSON event.

  Type Parameters

  • T

  Parameters

  • event: string
  • data: T
  • options: { id?: string } = {}

  Returns this

heartbeat

• heartbeat(): this

  Send a heartbeat comment to keep the connection alive.

  Returns this

setReconnectDelay

• setReconnectDelay(ms: number): this

  Tell the client to reconnect after ms milliseconds.

  Parameters

  • ms: number

  Returns this

close

• close(): void

  Close the stream.

  Returns void

toResponse

• toResponse(headers?: Record<string, string>): Response

  Build a standard SSE HTTP Response object.

  Parameters

  • headers: Record<string, string> = {}

    Additional HTTP headers to merge with the SSE defaults.

  Returns Response

  A Response with content-type text/event-stream.