Read Connect sessions in engine.io

npm install engine.io-session
2 downloads in the last week
37 downloads in the last month


NPM version Build Status

An engine.io plugin that allows you to read sessions created by the Connect session middleware.

It obtains the session id from the HTTP request headers and fetches the session data from a specified session store.


npm install engine.io-session


Example using Connect

var http = require('http');
var connect = require('connect');
var eio = require('engine.io');
var eioSession = require('engine.io-session');

var app = connect();
var cookieParser = connect.cookieParser();
var sessionStore = new connect.session.MemoryStore();
var sessionKey = 'sid';
var sessionSecret = 'your secret here';

app.use(connect.session({ store: sessionStore, key: sessionKey, secret: sessionSecret }));
app.use(function(req, res) {
  // Save variable to session.
  req.session.foo = 'bar';

var httpServer = http.createServer(app).listen(5000);
var server = eio.attach(httpServer);

server.on('connection', eioSession({
  cookieParser: cookieParser,
  store: sessionStore,
  key: sessionKey,
  secret: sessionSecret

server.on('session', function(socket, session) {
  // Receive variable from session.
  console.log(session.foo); // bar

Example using Express

Same as above. Replace connect with express.


The session events will be fired on the Server and Socket objects.


  • session
    • Called when a session for a socket is available.
    • Arguments
      • Socket: the Socket object
      • session: the session data


  • session
    • Called when a session for this socket is available.
    • Arguments
      • session: the session data
npm loves you