socket.io-handler

Init socket.io and set event handlers in a structured way.

Features

• Used with express.js
• Callback as ES6 generator

How to use

Boot express.js and start socket.io:

const express = require('express');
const app = express();
const port = 3300;
 
const server = app.listen(port, function(){
  console.log('Express server started at port: ', port);
}).on('error', function(err){
  console.log('Express server fail to start:', err);
});
 
/**
 * Boot socket.io
 */
const handler = require('socket.io-handler')(server);

Append handlers from files:

handler.require('./socketHandlers/user');
handler.require('./socketHandlers/auction');

Append handlers directly:

handler.defineEvents({
  someEvent: function *(){...}
});
 
handler.defineEvent('someEvent', function *(){...});

Note: For multiple defined events, all functions will be triggered.

APIs

handler.require(path)

Append handlers from a file

handler.defineEvents(eventMap)

Append handlers from a JSON object

handler.defineEvent(eventName, cb)

Append a handler for an event

Development

npm install
npm run example

And you should get output like

> node example/app.js

Listening for the socket.io events: [ 'userLogin', 'userUpdate', 'userInfo' ]
Express server started at port:  3300

Use your own socket.io client and have fun. :)