PubSub Client

The PubSub Client enables real-time publish/subscribe messaging. It connects to SignalWire and allows you to subscribe to channels and publish messages to them.

1
import { PubSub } from "@signalwire/realtime-api";
2
3
const pubSubClient = new PubSub.Client({
4
  project: "<project-id>",
5
  token: "<api-token>",
6
});

After instantiating, call subscribe() to join channels, then use publish() to send messages and listen for the message event to receive them. See Events for all available events.

Constructor

▸ new PubSub.Client(opts): PubSub.Client

Creates a new PubSub Client instance.

Parameters

Examples

Subscribing to channels

1
await pubSubClient.subscribe(["notifications"]);
2
3
pubSubClient.on("message", (message) => {
4
  console.log("Received:", message.content);
5
});

Publishing messages

1
await pubSubClient.publish({
2
  channel: "notifications",
3
  content: { type: "alert", text: "New update available" },
4
});