courage.js

JavaScript client for Courage using WebSockets.

Basic Usage

Create a client:

var uri = 'wss://courage-service-staging.tntapp.co/v1/ws/';
var providerId = '928308cd-eff8-4ef6-a154-f8268ec663d5';
var courage = new TheNewTricks.Courage.Client(uri, providerId);

You may optionally set subscribeOptions on the client to specify if undelivered messages should be replayed:

courage.subscribeOptions = {replay: true};

By default, undelivered messages are not replayed and are therefore discarded by the service.

Set authentication credentials:

publicKey = 'publicKey';
privateKey = 'ssssshSecret';
courage.authenticate(publicKey, privateKey);

Bind a callback function to a channel:

courage.bind('791f011e-7d16-4614-9e2f-1b28db45b7b3', function(data) {

  var uint8Data = new Uint8Array(data);
  var decoder = new TextDecoder('utf-8');
  var json = decoder.decode(uint8Data);

  var object = JSON.parse(json);

  console.log(object);
});

The above callback decodes the binary data into a UTF-8 string, and parses a JSON object from it.

Requirements

• All JavaScript source files are required. It is expected that you will concatenate, uglify, and minimize on your own.
• We aim to support the following browsers:
  • The latest version of Chrome
  • The latest version of Firefox
  • IE 10 and 11
  • Safari 6 and 7
• A polyfill for TextEncoding and TextDecoding is required.

Notes

Typed Arrays

Typed Arrays are used extensively throughout this project. They're not for performance though: almost every API in this project uses typed arrays:

• WebSocket
• crypto.getRandomBytes
• TextEncoder

• TextDecoder

  Converting these typed arrays to plain JS arrays and back all the time is silly and inefficient, so typed arrays abound!

Uint8Arrays

Related to the above, the default view on an ArrayBuffer is a Uint8Array. Not only is this the specific subtype used by TextEncoder, it also just makes sense for a network-oriented module like ours since network data is all octets.