Sse-express NPM

SSE express :satellite:

Server Sent Events middleware implementation for express

Install

npm install --save sse-express@next

The package requires express, because it was created directly for the framework. Also it utilizes ES6 features, so be sure that node v5.0+ is installed.

Usage

Use it simply a middleware for any of your routes. When is used as middleware method sse() is added to response object of the route. You can use it for sending messages to a client.

let sseExpress = require('./sse-express');
//...
app.get('/updates', sseExpress(), function(req, res) {
    res.sse({
        event: 'connected',
        data: {
          welcomeMsg: 'Hello world!'
        }
    });
});

On the client side you can listen to a message through EventSource instance:

let eventSource = new EventSource('http://localhost:80/updates');

eventSource.addEventListener('connected', (e) => {
    console.log(e.data.welcomeMsg);
    // => Hello world!
});

// listens to all the messages. The only way to catch unnamed events (with no `event` name set)
eventSource.onmessage = message => {
  console.log(message);
};

Important! Don't forget to check out browser compatibility of EventSource. At the moment it doesn't implemented in any versions of IE.

By default every 3000ms a handshake message will be sent to the client to not allow a browser lose a connection. Handshake message is just a comment that will not be caught by any of EventSource's events. You can configure the interval by passing handshake-interval query when initializing event source:

let eventSource = new EventSource('http://localhost:80/updates?handshake-interval=1000');

Or/and you can configure a handshake interval on server side:

let sseExpress = require('./sse-express');
//...
app.use(sseExpress({handshakeInterval: 1000}));

The same way you can configure a reconnection time (3000ms by default) after which browser will try to restore a connection if it is lost:

// fron-end setup
let eventSource = new EventSource('http://localhost:80/updates?retry=1000');

// or back-end setup
let sseExpress = require('./sse-express');
//...
app.use(sseExpress({retry: 1000}));

The priority of choosing which option to be used is (from low to high priority):

Default value
Server config
Client's query

Useful references about `EventSource`

API

res.sse({data, event, id} | Array<{data, event, id}>)

Accepts object representing an event stream or an array of objects:

data - can be either a string or an object. Object are converted to json string
[event] (optional) - event name
[id] (optional) - id of event

res.sse.lastEventId

Property which contains either Last-Event-Id header or lastEventId query parameter. Normally it's sent by browser in request headers. But not all (almost all) browsers do such. That's why middleware also can read query parameter lastEventId.

Every time res.sse called with not empty id parameter res.sse.lastEventId will be replaced with this value.