Skip to content
WebSocket interaction modeled as a pair of streams, for incoming and outgoing messages correspondingly
CoffeeScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
spec
.gitignore
Makefile
README.md
package.json
ws-chan.coffee
ws-chan.js

README.md

ws-chan

WebSocket interaction modeled as a pair of streams, for incoming and outgoing messages correspondingly. It provides:

  • JSON encoding/decoding of incoming/outgoing messages correspondingly
  • reconnect logic with exponential backoff (by default)

Example usage

On a client:

var channel = require('ws-chan');
var ch = channel('ws://localhost');

ch.in.on('data', function(message) {
  console.log('received', message);
});
ch.out.write({'data': 1});

Channel also emits open, end and error events on corresponding socket stream events.

On socket end and error channel tries to re-establish a connection after some timeout which is handled by node-backoff module (by default exponential backoff algorithm is used).

Something went wrong with that request. Please try again.