README.md

RealMQ Web SDK

This web SDK provides developer friendly access the RealMQ REST & Real-time APIs.

About

RealMQ is a highly scalable, privacy compliant real-time communication backbone. Our focus is to deliver great service with best possible integrability while you keep full control over your data.

Getting Started

Get in touch with us to get an RealMQ account set up. You can do that by sending an email to [email protected].

Installation

The easiest way to include the realmq web sdk to your page is to load it from unpkg.com.

<script src="https://unpkg.com/@realmq/web-sdk/dist/realmq.min.js"></script>

You can also use the npm module to integrate it in your custom frontend build pipeline (eg. browserify).

$ yarn add @realmq/web-sdk
// or
$ npm i -S @realmq/web-sdk

Usage

const realmq = new RealMQ('<AUTH_TOKEN>');

// create some resource
const subscription = await realmq.subscriptions.create({
  userId: 'user-1',
  channelId: 'channel-1',
  allowRead: true,
});

// or connect to the real-time API
await realmq.rtm.connect();

// and publish some message
realmq.rtm.publish({
  channel: 'channel-1',
  message: {
    text: 'Welcome!'
  }
});

// receive messages
realmq.rtm.on('message', (message) => {
  console.warn(`received new message in channel: ${message.channel}`, message.data)
});

Documentation

Please check out our full documentation on realmq.com/docs/web-sdk.

Credits

This SDK utilies and bundles the following awesome libs

• base64-js (License)
• paho.mqtt.javascript (License)
• promise (License)

---

LICENSE

The files in this archive are released under MIT license. You can find a copy of this license in LICENSE.