Server-Sent Events para envíos unidireccionales
Transmita actualizaciones en tiempo real a los clientes con el decorador @Sse y observables de RxJS.
Server-Sent Events para envíos unidireccionales es una lección gratuita de NestJS Enterprise Backend APIs en CoddyKit. Esta es la lección 3 de 4. Puedes leer la lección completa abajo gratuitamente — luego la practicas en el navegador con un editor de código integrado y un tutor de IA 24/7. Forma parte de la ruta de aprendizaje de NestJS Enterprise Backend APIs, y tu progreso se sincroniza en la web y la app de CoddyKit. El curso de NestJS Enterprise Backend APIs incluye 4 lecciones en total.
Partes de esta lección aún no han sido traducidas y se muestran en inglés.
Why Server-Sent Events?
Server-Sent Events (SSE) let a server push a continuous stream of updates to a client over a single, long-lived HTTP connection. It is the simplest way to deliver one-way, server-to-client live data such as notifications, progress bars, or dashboard metrics.
- One-way only: the server talks, the client listens. There is no client-to-server channel on the same connection.
- Plain HTTP: no special protocol upgrade like WebSockets need. It rides on a normal GET request.
- Auto-reconnect: the browser's
EventSourcereconnects automatically if the connection drops.
In NestJS, SSE is a first-class feature exposed through the @Sse() decorator combined with RxJS observables.
SSE vs WebSockets
Both stream live data, but they solve different problems. Choosing the right one is an architectural decision.
- SSE: server → client only, text-based, runs over HTTP/1.1 or HTTP/2, built-in reconnection and event IDs. Ideal for feeds, alerts, and progress.
- WebSockets: full-duplex (both directions), binary or text, requires a protocol upgrade. Ideal for chat, multiplayer games, and collaborative editing.
If your clients only need to receive updates, SSE is lighter, easier to scale behind standard HTTP infrastructure, and requires no extra client library. Reach for WebSockets only when the client must also push messages in real time.
The wire format
SSE is just a streaming HTTP response with the content type text/event-stream. Each message is a block of text fields separated by newlines, and each block ends with a blank line.
data:the payload (often a JSON string).event:a named event type the client can listen for.id:a message identifier used for reconnection viaLast-Event-ID.retry:the reconnection delay in milliseconds.
You rarely format this by hand in NestJS — the framework serializes a typed object into these fields for you — but knowing the shape helps you debug with curl.
// Raw text/event-stream bytes the server emits
// (NestJS builds this for you from a MessageEvent)
const sample =
'id: 42\n' +
'event: heartbeat\n' +
'data: {"status":"ok","ts":1718000000}\n' +
'\n';
process.stdout.write(sample);Your first @Sse endpoint
The @Sse() decorator marks a controller method as an SSE stream. Instead of returning a plain value, the method returns an RxJS Observable. Every value the observable emits becomes one SSE message sent to the client.
NestJS expects each emitted value to be a MessageEvent-shaped object with a data property. It automatically sets the text/event-stream headers and keeps the connection open.
import { Controller, Sse, MessageEvent } from '@nestjs/common';
import { interval, map, Observable } from 'rxjs';
@Controller('events')
export class EventsController {
@Sse('clock')
clock(): Observable<MessageEvent> {
return interval(1000).pipe(
map((n) => ({ data: { tick: n, time: new Date().toISOString() } })),
);
}
}The MessageEvent shape
NestJS exports a MessageEvent interface that maps directly onto the SSE wire fields. Only data is required; the rest are optional.
data— string or object. Objects are JSON-stringified automatically.type— becomes theevent:field (a named event).id— becomes theid:field, enabling resume-on-reconnect.retry— becomes theretry:field in milliseconds.
Returning a well-typed object keeps your stream self-documenting and lets clients subscribe to specific named events.
import { MessageEvent } from '@nestjs/common';
function buildEvent(orderId: string, n: number): MessageEvent {
return {
id: String(n),
type: 'order.updated',
retry: 5000,
data: { orderId, sequence: n },
};
}
console.log(buildEvent('ord_123', 7));Pushing domain events with a Subject
A fixed interval is fine for clocks, but real systems push when something happens. The idiomatic pattern is an RxJS Subject living in a service. Your business logic calls .next() on the subject whenever an event occurs, and the SSE endpoint simply exposes the subject as an observable.
This cleanly decouples the producer (any service) from the transport (the SSE controller).
import { Injectable, MessageEvent } from '@nestjs/common';
import { Subject, Observable } from 'rxjs';
@Injectable()
export class NotificationsService {
private readonly stream$ = new Subject<MessageEvent>();
emit(payload: unknown): void {
this.stream$.next({ type: 'notification', data: payload });
}
asObservable(): Observable<MessageEvent> {
return this.stream$.asObservable();
}
}Wiring the service to the controller
The controller injects the service and returns its observable from an @Sse() method. Any other part of the app — a queue consumer, a webhook handler, a cron job — can inject the same service and call emit() to broadcast to every connected client.
Because a plain Subject is multicast, all subscribers receive each emission. This is exactly what you want for a shared notification feed.
import { Controller, Post, Body, Sse, MessageEvent } from '@nestjs/common';
import { Observable } from 'rxjs';
import { NotificationsService } from './notifications.service';
@Controller('notifications')
export class NotificationsController {
constructor(private readonly notifications: NotificationsService) {}
@Sse('stream')
stream(): Observable<MessageEvent> {
return this.notifications.asObservable();
}
@Post()
publish(@Body() body: { message: string }) {
this.notifications.emit(body);
return { accepted: true };
}
}Per-user filtered streams
A global subject broadcasts to everyone. In an enterprise API you usually want each client to receive only their events. Use RxJS operators like filter and map to tailor the stream per request, reading the user from a route param or the authenticated request.
The @Sse() method can accept normal route decorators such as @Param() and @Req(), so you can scope the observable to the current user.
import { Controller, Param, Sse, MessageEvent } from '@nestjs/common';
import { Observable, filter, map } from 'rxjs';
import { EventsBus } from './events.bus';
@Controller('users')
export class UserFeedController {
constructor(private readonly bus: EventsBus) {}
@Sse(':userId/feed')
feed(@Param('userId') userId: string): Observable<MessageEvent> {
return this.bus.events$.pipe(
filter((e) => e.userId === userId),
map((e) => ({ type: e.kind, data: e.payload })),
);
}
}Heartbeats keep the connection alive
Proxies, load balancers, and browsers may close an idle connection. A heartbeat — a periodic comment or no-op event — keeps the pipe warm. With RxJS you merge your real event stream with a slow timer.
Send heartbeats as a distinct event type (or as SSE comment lines) so clients can ignore them. A common interval is every 15–30 seconds, comfortably under typical proxy idle timeouts.
import { merge, interval, map, Observable } from 'rxjs';
import { MessageEvent } from '@nestjs/common';
export function withHeartbeat(
source$: Observable<MessageEvent>,
): Observable<MessageEvent> {
const heartbeat$ = interval(15000).pipe(
map((): MessageEvent => ({ type: 'heartbeat', data: 'ping' })),
);
return merge(source$, heartbeat$);
}Cleanup, errors, and backpressure
When a client disconnects, NestJS unsubscribes from your observable. Make sure your stream releases resources on unsubscribe — use finalize() for cleanup and never leak timers or listeners.
- Use
catchErrorto convert errors into a final event instead of crashing the stream. - Use
finalizeto log or decrement a connection counter when the client leaves. - Beware backpressure: a fast producer with a slow client buffers in memory. Throttle or sample high-frequency sources.
import { Observable, catchError, finalize, of } from 'rxjs';
import { MessageEvent } from '@nestjs/common';
export function safeStream(
source$: Observable<MessageEvent>,
onClose: () => void,
): Observable<MessageEvent> {
return source$.pipe(
catchError((err) =>
of<MessageEvent>({ type: 'error', data: { message: err.message } }),
),
finalize(onClose),
);
}Consuming the stream from a client
Browsers consume SSE with the native EventSource API. It connects, dispatches messages, and reconnects automatically. Listen to the default message event for unnamed data, or add listeners for your named event types.
Note that EventSource only supports GET and cannot set custom headers, so auth is usually done via cookies or a token in the query string. Tools like curl -N are great for quick debugging from the terminal.
// Browser-side consumer
const es = new EventSource('/notifications/stream');
es.addEventListener('notification', (e) => {
const payload = JSON.parse(e.data);
console.log('new notification', payload);
});
es.addEventListener('heartbeat', () => {
// keep-alive, ignore
});
es.onerror = () => console.warn('reconnecting...');Quick Check
Test your understanding of when and how to use SSE in NestJS.
Recap
You learned how to stream one-way live updates from NestJS using Server-Sent Events:
- SSE is server-to-client only over plain HTTP, with built-in browser auto-reconnect — choose it over WebSockets when clients only need to receive.
- The
@Sse()decorator turns a controller method into a stream that returns anObservable<MessageEvent>; each emission becomes one message. - A
MessageEventmaps to the wire fieldsdata,type,id, andretry; objects are JSON-serialized for you. - Push real domain events with a shared
Subjectin a service, and scope per-user streams withfilterandmap. - Keep connections healthy with heartbeats via
merge, and clean up safely usingcatchErrorandfinalize. - Consume on the client with the native
EventSourceAPI.
Aprende TypeScript con un tutor de IA — gratis
Escribe y ejecuta código real en tu navegador, obtén ayuda instantánea de un tutor de IA disponible 24/7 y continúa donde lo dejaste en la web o en la aplicación.
- Cursos
- 20
- Lecciones
- 76
Preguntas frecuentes
¿La lección «Server-Sent Events para envíos unidireccionales» es gratis?
Sí — el texto completo de «Server-Sent Events para envíos unidireccionales» es gratis para leer aquí en la web. Para practicarla de forma interactiva (editor de código integrado y tutor de IA 24/7) y desbloquear el resto del curso de NestJS Enterprise Backend APIs, actualiza a CoddyKit PRO. El curso de NestJS Enterprise Backend APIs incluye 4 lecciones en total.
¿Qué aprenderé en «Server-Sent Events para envíos unidireccionales»?
Transmita actualizaciones en tiempo real a los clientes con el decorador @Sse y observables de RxJS. Practicas NestJS Enterprise Backend APIs con código real que ejecutas directamente en el navegador, y un tutor de IA 24/7 responde tus preguntas mientras trabajas en la lección.
¿Necesito experiencia previa para empezar NestJS Enterprise Backend APIs?
No se requiere experiencia previa. NestJS Enterprise Backend APIs en CoddyKit está estructurado para principiantes hasta estudiantes avanzados, así que puedes empezar aquí o desde el inicio y avanzar a tu ritmo. Esta es la lección 3 de 4.
¿Cuánto tiempo toma la lección «Server-Sent Events para envíos unidireccionales»?
La mayoría de las lecciones de CoddyKit toman alrededor de 5–10 minutos. Cada una es compacta e interactiva, así que avanzas constantemente y retomas exactamente por donde dejaste en la web y la app.
¿Puedo escribir y ejecutar código en esta lección de NestJS Enterprise Backend APIs?
Sí. Cada lección de NestJS Enterprise Backend APIs incluye un editor de código integrado, así que escribes y ejecutas código real directamente en tu navegador y obtienes retroalimentación instantánea de IA — sin configuración local necesaria.
Todas las lecciones de este curso
- Gateways de WebSocket con el adaptador de Socket.IO
- Autenticación y protección de conexiones Socket
- Server-Sent Events para envíos unidireccionales
- Escalado en tiempo real con un adaptador Redis Pub/Sub