Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

This package has been deprecated

Author message:

No longer maintained.

fi-sockets

3.0.0 • Public • Published

Fi Sockets

Sockets module loader for socket.io Node.js applications.

Installing

npm install --save fi-sockets

Usage

var sockets = require('fi-sockets');

Initialization

You must call it with your App's Server instance and a configuration object:

var sockets = require('fi-sockets');
var http = require('http');
var path = require('path');
 
var server = http.createServer();
 
sockets.init(server, config);
 
server.listen(0);
 
console.log('Server running on %d', server.address().port);

Configuration

The first argument is required and must be your application's Server instance. The socket.io instance will be attached to it.

The second argument is also required and it must be an Object with the following parameters:

  • debug: This parameter can be a Function to log with or a Boolean. If true it will use console.log.
  • basedir: This is required and must be a String. This should point to the absolute path where the socket module's scripts are located.
  • arguments: This is optional and can be an Array to apply to each socket module right after the default nsp and io arguments.
  • adapter: This is optional and it must be a socket.io adapter function.
  • options: This is optional and it's passed directly to io as the options argument.

Example Configuration

const redis = require('socket.io-redis');
const debug = require('debug');
const path = require('path');
 
module.exports = {
 
  basedir: path.normalize(path.join(__dirname, '..', 'sockets')),
 
  debug: debug('app:sockets'),
 
  arguments: [
    session
  ],
 
  adapter: redis({
    host: 'localhost',
    port: 6379
  })
 
};

Socket Modules

The socket modules inside your config.basedir folder must be like this:

module.exports = function (nsp) {
 
  nsp.on('connection', function (socket) {
 
    debug("A user connected to " + nsp.name);
 
    socket.on('disconnect', function () {
      debug("A user disconnected from " + nsp.name);
    });
 
  });
 
};

The exported function will receive the namespace instance as created with io.of(namespace), the current socket.io instance and the applied config.arguments. The namespace is created with the module's file name. If the module's file name is index.js then it'll be converted to /.

Folders are also respected, so if a socket module is located in <...>/sockets/chat/messaging.js then it's namespace will be /chat/messaging and if it's file name is index.js inside that same folder then it's namespace will be /chat.

The first two arguments will always be the generated namespace and the socket.io instance so you can define your socket namespace behavior. The rest of the parameters will be the ones you define in the config.arguments Array:

config.arguments = [
  /* Second argument */
  session,
 
  /* Third argument */
  function aFunction() {
    //...
  }
 
  /* And so on... */
];

Will be passed as:

/* mongoose.Schema will always be the first argument */
module.exports =  function (nsp, io, session, aFunction) {
 
  nsp.on('connection', function (socket) {
    //...
  });
 
};

Properties

The Sockets component exposes the following properties:

  • init: The initialization Function. Must be called before anything else with an options parameter as shown in the Initialization example.

  • io: The current socket.io instance.

  • modules: An Object that contains all the namespaces as properties.

  • of: A convenient method to retrieve the socket modules by its namespace path or name:

    /* These will both return the [chat] namespace */
    sockets.of('chat').emit('hello', 'everyone!');
    sockets.of('/chat').emit('hello', 'everyone!');
     
    /* These will both return the [chat/messaging] namespace */
    sockets.of('/chat/messaging').emit('hello', 'everyone!');
    sockets.of('chat/messaging').emit('hello', 'everyone!');

    If passed an empty String or a falsy value then it'll return the root namespace if it exists:

    /* These will all return the root namespace ('/') */
    sockets.of('/').emit('hello', 'everyone!');
    sockets.of('').emit('hello', 'everyone!');
    sockets.of().emit('hello', 'everyone!');

Install

npm i fi-sockets

DownloadsWeekly Downloads

1

Version

3.0.0

License

MIT

Last publish

Collaborators

  • avatar
  • avatar