Websocketwrapper NPM

WebSocketWrapper

Wrapper over the WebSocket class to manage disconnections transparently.

Installation

With npm:

$ npm install websocketwrapper

Usage in Node/Browserify

var WebSocketWrapper = require('websocketwrapper');

Usage Example

var ws = new WebSocketWrapper(url, protocol);

ws.reconnectionDelay = 5000;

ws.onopen = function() {
    console.log('connected');

    // Send some kind of registration message.
    ws.send('REGISTER');
};

ws.onreconnect = function() {
    console.log('reconnected');

    // Send some kind of registration message.
    ws.send('REGISTER');
};

ws.onmessage = function(e) {
    // do something
};

Documentation

`WebSocketWrapper` Class API

An instance of WebSocketWrapper holds an instance of a native WebSocket. The exposed API is the same as the native one. Just some differences/additions are described below.

`new WebSocketWrapper(url, protocols)` constructor

url and protocols mean the same as in the native API.

Events

open event is fired for the first WebSocket connection. If the connection is closed by the server or due to a netwotk error then close is fired and, after a delay, a new connection is attempted. If it connects to the server, reconnect event is fired.