@radzor/websocket-server

WebSocket server with room-based messaging, client management, and broadcasting. Built on the ws library for Node.js.

Networkingv0.1.0typescriptServerwebsocketrealtimeserverroomsbroadcastwsby Radzor

Install

$npx radzor@latest add websocket-server

⚠ Constraints: Requires the 'ws' npm package. Server-only — does not run in browsers. Each client gets a UUID on connection. Rooms are created on first join and removed when empty. heartbeatInterval=0 disables ping/pong.

Inputs

Name	Type	Default	Description
port*	number	—	Port to listen on.
path	string	/	URL path for WebSocket connections (default: /).
maxPayloadSize	number	1048576	Maximum message payload size in bytes (default: 1048576 = 1MB).
heartbeatInterval	number	30000	Ping interval in milliseconds for detecting dead connections (default: 30000).

port*number

Port to listen on.

pathstring

URL path for WebSocket connections (default: /).

{ "llm": { "constraints": "Requires the 'ws' npm package. Server-only — does not run in browsers. Each client gets a UUID on connection. Rooms are created on first join and removed when empty. heartbeatInterval=0 disables ping/pong.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/websocket-server", "tags": [ "websocket", "realtime", "server", "rooms", "broadcast", "ws" ], "events": [ { "name": "onConnection", "payload": { "clientId": "string", "remoteAddress": "string" }, "description": "Fired when a new client connects." }, { "name": "onMessage", "payload": { "data": "string", "clientId": "string", "isBinary": "boolean" }, "description": "Fired when a message is received from a client." }, { "name": "onDisconnect", "payload": { "code": "number", "reason": "string", "clientId": "string" }, "description": "Fired when a client disconnects." } ], "inputs": [ { "name": "port", "type": "number", "required": true, "description": "Port to listen on." }, { "name": "path", "type": "string", "default": "/", "required": false, "description": "URL path for WebSocket connections (default: /)." }, { "name": "maxPayloadSize", "type": "number", "default": 1048576, "required": false, "description": "Maximum message payload size in bytes (default: 1048576 = 1MB)." }, { "name": "heartbeatInterval", "type": "number", "default": 30000, "required": false, "description": "Ping interval in milliseconds for detecting dead connections (default: 30000)." } ], "radzor": "1.0.0", "actions": [ { "name": "broadcast", "params": [ { "name": "data", "type": "string", "description": "Message to broadcast." }, { "name": "room", "type": "string", "required": false, "description": "Room name to broadcast to. If omitted, broadcasts to all clients." }, { "name": "excludeClientId", "type": "string", "required": false, "description": "Client ID to exclude from broadcast." } ], "returns": "number", "description": "Broadcast a message to all clients or a specific room. Returns count of recipients." }, { "name": "sendToClient", "params": [ { "name": "clientId", "type": "string", "description": "Target client ID." }, { "name": "data", "type": "string", "description": "Message to send." } ], "returns": "boolean", "description": "Send a message to a specific client. Returns false if client not found." }, { "name": "joinRoom", "params": [ { "name": "clientId", "type": "string", "description": "Client ID to add to room." }, { "name": "room", "type": "string", "description": "Room name." } ], "returns": "void", "description": "Add a client to a room." }, { "name": "leaveRoom", "params": [ { "name": "clientId", "type": "string", "description": "Client ID to remove from room." }, { "name": "room", "type": "string", "description": "Room name." } ], "returns": "void", "description": "Remove a client from a room." }, { "name": "closeConnection", "params": [ { "name": "clientId", "type": "string", "description": "Client ID to disconnect." }, { "name": "code", "type": "number", "required": false, "description": "WebSocket close code (default: 1000)." }, { "name": "reason", "type": "string", "required": false, "description": "Close reason." } ], "returns": "void", "description": "Close a client's connection." } ], "outputs": [ { "name": "serverInfo", "type": "{ port: number; clientCount: number; roomCount: number }", "fields": [ { "name": "port", "type": "number", "description": "Listening port." }, { "name": "clientCount", "type": "number", "description": "Number of connected clients." }, { "name": "roomCount", "type": "number", "description": "Number of active rooms." } ], "description": "Current server status." } ], "runtime": "server", "version": "0.1.0", "category": "networking", "languages": [ "typescript" ], "description": "WebSocket server with room-based messaging, client management, and broadcasting. Built on the ws library for Node.js.", "dependencies": { "radzor": [], "packages": { "ws": "^8.0.0" } }, "composability": { "connectsTo": [ { "event": "onConnection", "description": "Log new WebSocket connections", "compatibleWith": [ "@radzor/log-aggregator.action.info.message", "@radzor/event-tracker.action.track.eventName" ] }, { "event": "onDisconnect", "description": "Track disconnections for analytics", "compatibleWith": [ "@radzor/event-tracker.action.track.eventName", "@radzor/log-aggregator.action.info.message" ] } ] } }

@radzor/websocket-server

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json