createSSEStream(req, res)

Create a Server-sent events write stream to support mocking EventSource.

Usage

*.mock.ts

import { createSSEStream, defineMock } from 'vite-plugin-mock-dev-server'

export default defineMock({
  url: '/api/sse',
  response: (req, res) => {
    const sse = createSSEStream(req, res) 
    sse.write({ event: 'message', data: { message: 'hello world' } })
    sse.end()
  }
})

Types

import type { Transform } from 'node:stream'

interface SSEStream extends Transform {
  write: (message: SSEMessage, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void) => boolean
  write: (message: SSEMessage, cb?: (error: Error | null | undefined) => void) => boolean
}

interface SSEMessage {
  data?: string | object
  comment?: string
  event?: string
  id?: string
  retry?: number
}