@radzor/sse-stream

Server-Sent Events (SSE) streaming server. Create named streams, push typed events, and manage client connections with automatic reconnection support.

Networkingv0.1.0typescriptServersseserver-sent-eventsstreamingrealtimehttppushby Radzor

Install

View source on GitHub →

$npx radzor@latest add sse-stream

⚠ Constraints: Server-only. The createStream handler must be mounted on an HTTP server (Node http module, Express, Fastify, etc.). No external dependencies. Clients reconnect automatically via the retry field. Use keepAliveInterval to prevent proxy/load-balancer timeouts.

Inputs

Name	Type	Default	Description
retryMs	number	3000	Reconnection interval hint sent to clients (default: 3000ms).
keepAliveInterval	number	15000	Interval in ms for sending keep-alive comments to prevent connection timeout (default: 15000).
maxClients	number	1000	Maximum number of concurrent SSE clients per stream (default: 1000).

retryMsnumber

Reconnection interval hint sent to clients (default: 3000ms).

default: 3000

keepAliveIntervalnumber

Interval in ms for sending keep-alive comments to prevent connection timeout (default: 15000).

default: 15000

{ "llm": { "constraints": "Server-only. The createStream handler must be mounted on an HTTP server (Node http module, Express, Fastify, etc.). No external dependencies. Clients reconnect automatically via the retry field. Use keepAliveInterval to prevent proxy/load-balancer timeouts.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/sse-stream", "tags": [ "sse", "server-sent-events", "streaming", "realtime", "http", "push" ], "events": [ { "name": "onClientConnected", "payload": { "clientId": "string", "streamId": "string", "lastEventId": "string" }, "description": "Fired when a client subscribes to a stream." }, { "name": "onClientDisconnected", "payload": { "clientId": "string", "streamId": "string" }, "description": "Fired when a client disconnects from a stream." } ], "inputs": [ { "name": "retryMs", "type": "number", "default": 3000, "required": false, "description": "Reconnection interval hint sent to clients (default: 3000ms)." }, { "name": "keepAliveInterval", "type": "number", "default": 15000, "required": false, "description": "Interval in ms for sending keep-alive comments to prevent connection timeout (default: 15000)." }, { "name": "maxClients", "type": "number", "default": 1000, "required": false, "description": "Maximum number of concurrent SSE clients per stream (default: 1000)." } ], "radzor": "1.0.0", "actions": [ { "name": "createStream", "params": [ { "name": "streamId", "type": "string", "description": "Unique stream identifier." } ], "returns": "{ streamId: string; handler: (req: IncomingMessage, res: ServerResponse) => void }", "description": "Create a named SSE stream and return the HTTP handler to mount on your server." }, { "name": "pushEvent", "params": [ { "name": "streamId", "type": "string", "description": "Target stream ID." }, { "name": "data", "type": "string | object", "description": "Event data (objects are JSON-serialized)." }, { "name": "eventType", "type": "string", "required": false, "description": "SSE event type (maps to 'event:' field). Default: 'message'." }, { "name": "id", "type": "string", "required": false, "description": "Event ID for Last-Event-ID tracking." } ], "returns": "number", "description": "Push an event to all clients on a stream. Returns number of clients reached." }, { "name": "closeStream", "params": [ { "name": "streamId", "type": "string", "description": "Stream to close." } ], "returns": "void", "description": "Close a stream and disconnect all its clients." } ], "outputs": [ { "name": "streamInfo", "type": "{ streamId: string; clientCount: number; totalEventsSent: number }", "fields": [ { "name": "streamId", "type": "string", "description": "Stream identifier." }, { "name": "clientCount", "type": "number", "description": "Number of connected clients." }, { "name": "totalEventsSent", "type": "number", "description": "Total events pushed to this stream." } ], "description": "Current stream statistics." } ], "runtime": "server", "version": "0.1.0", "category": "networking", "languages": [ "typescript" ], "description": "Server-Sent Events (SSE) streaming server. Create named streams, push typed events, and manage client connections with automatic reconnection support.", "dependencies": { "radzor": [], "packages": {} }, "composability": { "connectsTo": [ { "event": "onClientConnected", "description": "Log SSE client connections", "compatibleWith": [ "@radzor/log-aggregator.action.info.message", "@radzor/event-tracker.action.track.eventName" ] }, { "event": "onClientDisconnected", "description": "Track client disconnections", "compatibleWith": [ "@radzor/log-aggregator.action.info.message" ] } ] } }

@radzor/sse-stream

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json