Code Monkey home page Code Monkey logo

socket.io-request's Introduction

socket.io-request

bidirectional request-response for socket.io

Circle CI

Feature

Of cource, Socket.IO's emit and on have request-response. This library adds some features.

  • Promise interface
  • Exception handling
    • timeout
    • disconnect

Install

% npm install socket.io-request -save

Methods

  • request("method", data) return Promise
  • response("method", handler)

Usage

request from Client to Server

client

var ioreq = require("socket.io-request");
var io = require("socket.io-client")("http://localhost:3000");

io.on("connect", function(){
  ioreq(io).request("toUpper", "hello world") // method, data
    .then(function(res){
      console.log(res); // get "HELLO WORLD"
    })
    .catch(function(err){
      console.error(err.stack || err);
    });
});

server

var ioreq = require("socket.io-request");
var io = require("socket.io")(3000);

io.on("connection", function(socket){ // new client
  ioreq(socket).response("toUpper", function(req, res){ // method, handler
    res(req.toUpperCase()); // return to client
  });
});

request from Server to Client

server

var ioreq = require("socket.io-request");
var io = require("socket.io")(3000);

io.on("connection", function(socket){ // new client
  ioreq(io).request("windowSize")
    .then(function(res){
      console.log(res); // get {height: 528, width: 924}
    });
});

client (web browser)

var ioreq = require("socket.io-request");
var io = require("socket.io-client")("http://localhost:3000");

io.on("connect", function(){
  ioreq(io).response("windowSize", function(req, res){
    res({
      height: window.innerHeight,
      width: window.innerWidth
    }); // return to server
  });
});

Error handling

res.error returns error object to requester.

ioreq(io).response("foo", function(req, res){
  if(typeof req !== "string") return res.error(new Error("request is not String"));
  res("foo!" + req);
});
ioreq(io).request("foo", 123)
  .then(function(res){
    console.log(res);
  })
  .catch(function(err){
    console.error(err); // =>  "[Error: request is not String]"
  });

Options

var options = {
  event: "socket.io-request", // event name on socket.io
  timeout: 90000              // request timeout (msec)
};

ioreq(io, options).request("foo");

Async-Await

Using async-await syntax, you can write like below.

async () => {
  const res = await ioreq(io).request("hello");
};

Samples

in ./sample directory.

Develop

% npm i
% npm run build
% npm test

socket.io-request's People

Contributors

shokai avatar sundarasan avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.