socket.io-session-middleware

Don't miss out on this year's npm Pride t-shirt designs!Order your favorites here »

socket.io-session-middleware

0.1.0 • Public • Published 3 years ago

socket.io-session-middleware

Share connect/express sessions with socket.io 1.x

Setup

Example

Server

var socketSession = require("socket.io-session-middleware");
    
var session = {
    store: new connect.session.MemoryStore(),
    secret: "secret",
    key: "mykey.sid",
    cookieParser: connect.cookieParser("secret")
};
 
io.use(socketSession(session));
 
io.on("connection", function(socket){
 
    socket.on("whoAreYou", function(callback){
        
        //read from session
        callback(socket.session.name);
    });
    
    socket.on("setName", function(data) {
        
        //write to session
        socket.session.name = data.name;
    })
});

Client

 
socket.emit("setName", { name: "hans" });
 
socket.emit("whoAreYou", function(name) { 
    console.log("I am " + name); 
});
 
 
//=> I am hans

A full featured example can be found in the example folder.

Notes

Make sure to fire a http request to initialize the session/cookie before accessing the session with socket.io. If you are serving the socket.io client with your node.js server this won't be a problem for you.