ShokupanWebsocketRouter

Defined in: src/websocket.ts:81

WebSocket Router for organizing WebSocket endpoints.

Provides lifecycle hooks and event-based message routing.

Example

const wsRouter = new ShokupanWebsocketRouter();

wsRouter.onUpgrade((ctx) => {
  if (!ctx.get("authorization")) return false;
  return true;
});

wsRouter.onOpen((ctx, ws) => {
  return { userId: "123" }; // Sets ws.data and ctx.state
});

wsRouter.event("chat.message", (ctx, data) => {
  ctx.broadcast("chat.message", data);
});

app.mount('/ws', wsRouter);

Type Parameters

T

T extends Record<string, any> = any

Constructors

Constructor

new ShokupanWebsocketRouter<T>(): ShokupanWebsocketRouter<T>

Returns

ShokupanWebsocketRouter<T>

Properties

middleware

middleware: any[] = []

Defined in: src/websocket.ts:84

Accessors

registry

Get Signature

get registry(): object

Defined in: src/websocket.ts:310

Registry Accessor to support Dashboard Graph

Returns

object

controllers

controllers: never[] = []

events

events: any[]

metadata

metadata: undefined = undefined

middleware

middleware: never[] = []

routers

routers: never[] = []

routes

routes: never[] = []

Methods

event()

event(name, handler): this

Defined in: src/websocket.ts:167

Register an event handler.

Parameters

name

string

Event name

handler

EventHandler<T>

Handler function

Returns

this

Example

router.event("chat.message", (ctx, data) => {
  ctx.broadcast("chat.message", data);
});

---

getRoutes()

getRoutes(): any[]

Defined in: src/websocket.ts:303

Returns

any[]

---

mount()

mount(prefix, router): this

Defined in: src/websocket.ts:266

Mount a child WebSocket router or controller to share the same connection. Events from the child will be prefixed with the mount path.

Parameters

prefix

string

Event prefix for the child router (e.g., “chat” makes “message” become “chat.message”)

router

any

Child WebSocket router or controller to mount

Returns

this

Example

const mainRouter = new ShokupanWebsocketRouter();
const chatRouter = new ShokupanWebsocketRouter();
chatRouter.event("message", (ctx, data) => { ... });

// Events will be accessible as "chat.message"
mainRouter.mount("chat", chatRouter);

---

onClose()

onClose(handler): this

Defined in: src/websocket.ts:131

Register close handler. Called when WebSocket connection is closed.

Parameters

handler

(ctx, ws, code?, reason?) => void | Promise<void>

Returns

this

---

onError()

onError(handler): this

Defined in: src/websocket.ts:140

Register error handler. Called when an error occurs.

Parameters

handler

(ctx, ws, error) => void | Promise<void>

Returns

this

---

onEvent()

onEvent(handler): this

Defined in: src/websocket.ts:113

Register event middleware handler. Called before routing to specific event handlers. Return false or throw to prevent event routing.

Parameters

handler

(ctx, ws, event, data) => boolean | void | Promise<boolean | void>

Returns

this

---

onMessage()

onMessage(handler): this

Defined in: src/websocket.ts:122

Register message handler. Called for every message before event parsing/routing.

Parameters

handler

(ctx, ws, message) => void | Promise<void>

Returns

this

---

onOpen()

onOpen(handler): this

Defined in: src/websocket.ts:103

Register open handler. Called after WebSocket connection is established. Return value is automatically set to both ws.data and ctx.state.

Parameters

handler

(ctx, ws) => any

Returns

this

---

onStop()

onStop(handler): this

Defined in: src/websocket.ts:149

Register stop handler. Called when the server is stopped.

Parameters

handler

(app) => void | Promise<void>

Returns

this

---

onUpgrade()

onUpgrade(handler): this

Defined in: src/websocket.ts:93

Register upgrade validation handler. Called when HTTP upgrade request is received. Return false to reject the upgrade.

Parameters

handler

(ctx) => boolean | void | Promise<boolean | void>

Returns

this