@superviz/realtime NPM

SuperViz Real-time

SuperViz Real-time is a powerful package that enables real-time communication and collaboration in JavaScript-based applications. It provides a simple yet flexible API for creating channels, publishing events, and subscribing to real-time updates.

Features

Easy integration with JavaScript and Node.js projects
Real-time communication between participants
Flexible event publishing and subscription system
Support for both package manager and CDN installation methods

Installation

Using a package manager

npm install --save @superviz/realtime

Using CDN

Add the following script tag to your HTML file:

<script type="module" src="https://unpkg.com/@superviz/realtime@latest/dist/browser/index.js"></script>

Quick Start

JavaScript

import { Realtime } from '@superviz/realtime';

// Initialize Real-time
const realtime = new Realtime('DEVELOPER_KEY', {
  participant: {
    id: 'PARTICIPANT_ID',
  },
});

// Connect to a channel
const channel = await realtime.connect("my-channel");

// Publish an event
channel.publish("test", { message: "Hello, world!" });

// Subscribe to events
channel.subscribe("test", (event) => {
  console.log("Received test event:", event);
});

Node.js

import { Realtime } from '@superviz/realtime';

// Initialize Real-time
const realtime = new Realtime(
  {
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_SECRET',
  },
  {
    participant: {
      id: 'PARTICIPANT_ID',
    },
  }
);

// Connect to a channel
const channel = await realtime.connect("my-channel");

// Publish an event
channel.publish("test", { message: "Hello, world!" });

// Subscribe to events
channel.subscribe("test", (event) => {
  console.log("Received test event:", event);
});