serinus-realtime-features

Enable real-time communication in Serinus applications using WebSockets and SSE.

108|11|Updated Jan 25, 2023
One-click install
npx skills add https://github.com/francescovallone/serinus --skill serinus-realtime-features
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: serinus-realtime-features
Source: https://github.com/francescovallone/serinus/tree/main/packages/serinus/skills/serinus-realtime-features
Command: npx skills add https://github.com/francescovallone/serinus --skill serinus-realtime-features

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Enables real-time communication in Serinus applications using WebSockets and SSE, helping teams push live updates and events to connected clients.

Core Features & Use Cases

  • WebSocket gateways: build bidirectional, low-latency channels by extending WebSocketGateway and registering WsModule.
  • SSE streams: push server-sent events to clients via SseController and SseEmitter.
  • Modular integration: combine WsModule and SseModule in a single RealtimeModule to support both protocols and scalable event delivery.
  • Use Case: notify users about live status changes, chat messages, or collaborative edits in real-time across clients.

Quick Start

Configure and start real-time features by registering WsModule and SseModule, then open a WebSocket gateway or SSE stream.

Frequently Asked Questions about serinus-realtime-features

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add real-time notifications to a Serinus application?

To add real-time notifications, import WsModule and SseModule into your Serinus application, then configure WebSocketGateway or SseController instances to push live updates and events to connected clients.

When should I use WebSocket gateways versus SSE streams for live dashboards?

Use WebSocket gateways for bidirectional, low-latency channels requiring client interaction, and use SSE streams via SseEmitter when you only need to push server-sent events unidirectionally to clients.

Can I combine WebSockets and SSE in a single Serinus module?

Yes, you can combine WebSockets and SSE in a single Serinus module by integrating both WsModule and SseModule to support both protocols and scalable event delivery across clients.

How do I set up a WebSocket gateway in Serinus?

Set up a WebSocket gateway in Serinus by extending the WebSocketGateway class, registering WsModule, and wiring proper gateway lifecycle and dependency-injection-supported event emitters.

Does Serinus support dependency injection for real-time event emitters?

Yes, Serinus supports dependency-injected event emitters, allowing proper gateway and controller lifecycle wiring for real-time features across application modules.

What are the limitations of using SSE for real-time collaborative features?

SSE via SseController and SseEmitter is unidirectional, so collaborative features requiring simultaneous bidirectional client updates need WebSocket gateways instead to handle low-latency interactions.