Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
46 lines
1.2 KiB
Plaintext
46 lines
1.2 KiB
Plaintext
# EventSource
|
|
|
|
> ⚠️ Warning: the EventSource API is experimental.
|
|
|
|
Undici exposes a WHATWG spec-compliant implementation of [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)
|
|
for [Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events).
|
|
|
|
## Instantiating EventSource
|
|
|
|
Undici exports a EventSource class. You can instantiate the EventSource as
|
|
follows:
|
|
|
|
```mjs
|
|
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:
|
|
|
|
```mjs
|
|
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](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
|