ShinyWebSocket

Super lightweight and simple WebSocket client with routes support for browsers.

Why routes

Since we don't have the concept of routing in the native websocket API, developers must define strategies to redirect the websocket messages in a way to classify them, wich can result in big and hard-to-read switch-cases.

So, routing is a way to easily organize your code and keep it as cleaner as possible.

Example

Easily create your route and configure it:

let ws = new ShinyWebSocket("ws://demos.kaazing.com/")
            .CreateRoute("/echo")
            .OnOpen("/echo", function() {
                document.body.innerHTML = "Connection Opened! - ";
            })
            .OnMessage("/echo", function(msg) { 
                document.body.innerHTML += msg.data
            });

Send messages to specific routes:

 ws.Send("/echo", "Hello World!");

The object of the fluent syntax is to just help you to make one-time configuration, but you can attach event handlers or create routes anytime:

  ws.OnMessage("/echo", function(msg) { 
    alert(msg.data);
  });

ShinyWebsocket also wants to help you inspect how things are going on by calling the route description method:

ws.GetRoutesDescription()

Which will give you an JSON object containing the registered routes, whether they are opened or not and the amount of handlers that are registered.

{
  "/echo": {
    "isOpen": true,
    "eventHandlers": {
      "onclose": 0,
      "onmessage": 1,
      "onerror": 0,
      "onopen": 1
    }
  }
}