serverpod-streams

You build real-time WebSocket streaming APIs by defining Dart endpoint methods that accept or return Stream<T> with serializable types, then running serverpod generate to produce the client stubs for consumption.

WebSocket session lifecycle management keeps sessions alive for return streams until the stream completes or is cancelled, and automatically closes streams on WebSocket disconnect.

Streaming errors are propagated to the client over WebSockets by throwing serializable exceptions, which are delivered through the stream's onError callback for predictable error handling.

Yes, you need serializable types for Serverpod stream endpoints because both the streamed item types and any exceptions propagated via onError must be serializable to traverse the WebSocket boundary.

A key limitation is that all streamed item types and exceptions must be serializable, and streams are constrained by WebSocket session lifecycle behavior, closing automatically on disconnect.