TypeScript SDK
The ZeroHub provides a TypeScript Client SDK to make it simple and type-safe to use the API.
Installation
Section titled “Installation”npm install @zero-hub/clientImport the SDK and initialize the client
import { ZeroHubClient, LogLevel } from "@zero-hub/client";
const zh = new ZeroHubClient( // ZeroHub hosts ["sg1.zerohub.dev"], // ZeroHub configs { logLevel: LogLevel.Debug, // if data channel config is set, zerohub will automatically create the data channel to other peers dataChannelConfig: { // add callback to create datachannel before making connection onDataChannel: (peer, dataChannel, isOwner) => { // handle all data channel to receive the message from the peer dataChannel.onmessage = (ev: MessageEvent) => { console.log(`Pong from ${peer.id}: ${ev.data}`); }; // send message to the peer though WebRTC data channel dataChannel.send(`Ping to ${peer.id}`); }, }, });Topologies
Section titled “Topologies”The SDK ships with two built-in topologies. Choose one by passing an instance as the third argument to the ZeroHubClient constructor — the default is MeshTopology:
import { ZeroHubClient, LogLevel, MeshTopology, SFUTopology } from "@zero-hub/client";
// Mesh: every peer connects to every other peer (default)const meshClient = new ZeroHubClient(hosts, { logLevel: LogLevel.Debug }, new MeshTopology());
// SFU: a star topology where one peer (by default the numerically lowest peer id)// holds a connection to every client — more scalable for larger groupsconst sfuClient = new ZeroHubClient(hosts, { logLevel: LogLevel.Debug }, new SFUTopology());For a custom strategy, implement the Topology interface. See the SDK reference for details on how each built-in topology behaves.