Fetch SSE (Server-Sent Events)

This package provides an easy API for making Event Source requests with all the features of Fetch API, and supports browsers and Node.js.

For Node.js, v18.0.0 or higher required.

Install

npm install fetch-sse

Usage

1import { fetchEventData } from 'fetch-sse';
2
3await fetchEventData('/api/sse', {
4  method: 'POST',
5  data: { foo: 'bar' },
6  headers: {
7    'Content-Type': 'application/json',
8    'Authorization': 'Bearer token'
9  },
10  onMessage: (event) => {
11    console.log(event);
12  }
13})

You can pass in other parameters in a similar way to the Fetch API.

1import { fetchEventData } from 'fetch-sse';
2
3await fetchEventData('/api/sse', {
4  method: 'POST',
5  data: { foo: 'bar' },
6  headers: {
7    'Content-Type': 'application/json',
8    'Authorization': 'Bearer token'
9  },
10  signal: ctrl.signal,
11  onMessage: (event) => {
12    console.log(event.data);
13  }
14})

Interface

1export interface IFetchOptions {
2  method?: string;
3  headers?: HeadersInit | Record<string, any>;
4  data?: Record<string, any>;
5  signal?: AbortSignal;
6  onMessage?: (event: ServerSentEvent | null, done?: boolean) => void;
7  onOpen?: (res?: Response) => void;
8  onClose?: () => void;
9  onError?: (error: any) => void;
10}
11
12// decoded event
13export interface ServerSentEvent {
14  event: string | null;
15  data: string;
16  raw: string[];
17}

Event stream pattern

The event stream is a simple stream of text data that encoded using UTF-8. You can find more information here.

• Data-only messages

raw:

1
2data: {"username": "bobby", "time": "02:33:48"}\n\n

parsed:

1{
2  event: null,
3  data: '{"username": "bobby", "time": "02:33:48"}',
4  raw: [
5    'data: {"username": "bobby", "time": "02:33:48"}'
6  ]
7}

• Named events

raw:

1:HTTP\n
2id: 1\n
3event: result\n
4data: {"username": "bobby", "time": "02:33:48"}\n\n

parsed:

1{
2  event: 'result',
3  data: {"username": "bobby", "time": "02:33:48"},
4  raw: [
5    ':HTTP',
6    'id: 1',
7    'event: result',
8    'data: {"username": "bobby", "time": "02:33:48"}'
9  ]
10}

Compatibility

this package is written in typescript and compatible with browsers and nodejs, You might need to polyfill TextDecoder for old versions of browsers.