Briklab Docs

Installing @briklab/slokr ​

This page explains how to install and verify @briklab/slokr.

Install ​

bash
pnpm add @briklab/slokr
bash
npm install @briklab/slokr
bash
yarn add @briklab/slokr

Basic Verify ​

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

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

console.log(server.stats.ready); // true

Requirements Notes ​

  • WebSocket mode can run over Node HTTP server.
  • WebTransport and Hybrid modes require local certificate generation through OpenSSL (handled internally).

If OpenSSL is missing, startup throws a Slokr.Error.

Next Steps ​