Skip to main content
Version: Next

EventSource

⚠️ Warning: the EventSource API is experimental.

Undici exposes a WHATWG spec-compliant implementation of EventSource for Server-Sent Events.

Instantiating EventSource​

Undici exports a EventSource class. You can instantiate the EventSource as follows:

import { EventSource } from 'undici'

const eventSource = new EventSource('http://localhost:3000')
eventSource.onmessage = (event) => {
  console.log(event.data)
}

Using a custom Dispatcher​

undici allows you to set your own Dispatcher in the EventSource constructor.

An example which allows you to modify the request headers is:

import { EventSource, Agent } from 'undici'

class CustomHeaderAgent extends Agent {
  dispatch (opts) {
    opts.headers['x-custom-header'] = 'hello world'
    return super.dispatch(...arguments)
  }
}

const eventSource = new EventSource('http://localhost:3000', {
  dispatcher: new CustomHeaderAgent()
})

More information about the EventSource API can be found on MDN.