Skip to content

slokr

ts
slokr(type: Slokr.ValidMode, port?: number, host?: string): Slokr;

Factory function that returns a new Slokr instance.

Parameters

ParamTypeDescription
typeSlokr.ValidMode"WebSocket", "WebTransport", or "Hybrid".
portnumber | undefinedOptional listen port (default 3000).
hoststring | undefinedOptional host (default "0.0.0.0").

Returns

Example

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

const server = slokr(Slokr.Hybrid, 3000);
await server.connected;

server.on("ping", async (_, client) => {
  await server.sendTo(client, "pong", { ok: true });
});