socket.io-laravel

Socket.IO middleware for interoperation with Laravel.

Example

const http = require("http");
const io = require("socket.io");
const {session} = require("socket.io-laravel");
const httpServer = http.createServer();
const socketServer = io(httpServer);
const appKey = "..."        // Laravel application encryption key

// setup middleware
socketServer.use(session(appKey, async id => {
    // load session data from storage and resolve
})));

// middleware adds .session to socket.request object
socketServer.sockets.on("connect", socket => {
    console.log(socket.request.session);
});

API

session(key, [cookieName], fetch, [console]) => function

Create Socket.IO middleware to load Laravel session data. The key must match the Laravel app.key. The fetch function takes a string session id and should return a Promise that resolves to the session data. If a console object is provided, logs will be written to it.