README.md

A JS client for the relay service which relays server-side messages to client-side subscribers (e.g. browser) via websockets.

Installation

npm install relay-ninja --save-dev

Usage

import {RelayClient} as $ from 'relay-ninja'

const client = RelayClient(
    'your_api_key...',
    {
        'on_message': (message) => {
            console.log(message)
        }
    }
)

client.auth(
    'burt',
    'your_user_session',
    ['global', ...]
)