es-wrapper

v0.1.0

Published

2 years ago

ESWrapper makes your express.js powered API accessible through real-time sockets with Socket.io.

Downloads

0High
0Medium
0Low

timofeybiryukov

express socket.io wrapper

Express Socket.io Wrapper

ESWrapper for short

ESWrapper makes your express.js powered API accessible through real-time sockets with Socket.io.

[Disclaimer: remember, this lib is in the TEST mode right now (not fully production tested)]

Installation

In console:

npm install es-wrapper

In code:

require('es-wrapper');

Usage

Create your standard express.js application, require es-wrapper, just instead of doing app.listen(PORT); do new ESWrapper(app).listen(PORT);.

Don't forget to pass express application as a first parameter to ESWrapper: new ESWrapper(expressApp).

    var app = require('express')();
    var ESWrapper = require('es-wrapper');
    
    // app.listen(8080);
    new ESWrapper(app).listen(8080);
    
    app.get('/', function (req, res) {
      res.sendfile(__dirname + '/index.html');
    });
    
    app.get('/sayHi', function (req, res) {
      res.end('Hello World!');
    });

Now you can access /sayHi route with both http(xhr) and socket.io client. index.html:

    <script src="/socket.io/socket.io.js"></script>
    <script>
      var socket = io.connect('http://localhost:8080');
    
      socket.emit('request', {
        path: '/sayHi',
        method: 'get',
        headers: {},
        body: {}
      });
    
      socket.on('response', function (res) {
        alert(res.body); // Hello World!
      });
    
    </script>

And still have access with http:

    <script src="http://code.jquery.com/jquery-1.12.1.min.js"></script>
    <script>
      $.get('http://localhost:8080/sayHi', function(data) {
        alert(data); // Hello World!
      });
    </script>

Need access to raw socket.io? No problem:

    var express = require('express');
    var ESWrapper = require('es-wrapper');
    var wrapper = new ESWrapper(express());
    var app = wrapper.app;
    var io = wrapper.io;
    
    wrapper.listen(); // default port will be 80
    
    app.get('/', function(req, res) {
      res.sendfile(__dirname + '/index.html');
    });
    
    io.on('connection', function(socket) {
      socket.emit('hello', { hello: 'world' });
    });

Separate socket logic & http. Req will have isSocket: true value and socketIO object witch is socket.io connected socket. Also req.connection is same as socketIO.

    app.delete('/socketIOtest', function(req, res) {
      if (req.isSocket) { // req.isSocket is always true for socket requests
        req.socketIO.emit('extra', 200); // req.socketIO is socket received on connection
        req.connection.emit('extra', 200); // same here
      }
      res.sendStatus(200);
    });

wrapper.client.io.js

Another alternative is to use wrapper.client.io.js. It is small wrapper to provide REST methods and callbacks, to better emulate REST http API.

wrapper.client.io.js can be used both in node.js and browser

node:

    var ESWrapper = require('es-wrapper');
    var wrapperClient = ESWrapper.IOFactory;
    var SocketClient = require('socket.io-client');
    
    var io = new IOFactory(SocketClient);

io (browser):

Don't forget to grab wrapper.client.io.js from repo root express-socket.io-wrapper/client/io.js and include it in your page however you like.

    var wrapperIO = new IOFactory();
    
    wrapperIO.get('/someUrl', function(res) {});
    wrapperIO.post('/someUrl', {
      data: 'some body data'
    }, {
      'Content-Type': 'application/json'
    }, function(res) {});
    wrapperIO.put('/someUrl', function(res) {});
    wrapperIO.delete('/someUrl', function(res) {});