Skip to content

@briklab/slokr

@briklab/slokr is the server-side companion to @briklab/slikr.

It lets you run a real-time server in one of three modes:

  • "WebSocket"
  • "WebTransport"
  • "Hybrid" (both protocols at once)

Install

Follow the common installation tutorial

Quick Start

ts
import slokr, { Slokr } from "@briklab/slokr";

const server = slokr(Slokr.Hybrid, 3000, "0.0.0.0");

await server.connected;

server.on("connection", (_, client) => {
  console.log("Client connected from", client.client.from);
});

server.on("chat:message", async (payload, client) => {
  await server.sendTo(client, "chat:ack", { ok: true });
  await server.broadcast("chat:message", payload);
});

API

Exported

Functions

Classes

Namespaces

Tutorials