Server-Sent Event (SSE) Parser

This package provides a streaming parser for server-sent events.

Typically, in JavaScript, you would use an EventSource to receive server-sent events. This API has some limitations, however, if you would like to make a POST request, or prefer a promise- or stream-based API.

SSEParserStream

If you make a fetch request and want to process the response body, you could pipe it through SSEParserStream like so:

1const response = await fetch(...)
2const stream = response.body
3    .pipeThrough(new TextDecoderStream())
4    .pipeThrough(new SSEParserStream());
5
6for await (const chunk of stream) {
7    yield chunk
8}

SSEParser

If you would prefer lower-level access, you can use the SSEParser directly and provide it with callbacks whenever an event is dispatched, or when the reconnection time of the stream is changed.

1const parser = new SSEParser({
2  dispatchEvent: (event) => {...},
3  setReconnectionTime: (time) => {...},
4});

Exported Types

1interface SSE {
2  type: string; // The event type, defaults to "message"
3  data: string; // Actual event data
4  lastEventId: string; // The last event ID, if any
5}

1interface IEventSource {
2  dispatchEvent(event: SSE): void; // Called whenever a new SSE is processed
3  setReconnectionTime?: (time: number) => void; // Called whenever the stream's reconnection time is updated
4}