serverpod-streams

What problem does it solve?

Serverpod streaming removes the friction of turning server-side stream data into real-time, WebSocket-managed updates that clients can consume reliably.

Core Features & Use Cases

• Stream endpoint parameters and return values: Define Dart methods that accept Stream<T> or return Stream<T> to get WebSocket-managed client stubs.
• Session and lifecycle management: Keeps sessions alive for return streams until the stream completes or is cancelled, and closes streams on WebSocket disconnect.
• Serializable types and error propagation: Ensures streamed item types are serializable and propagates serializable exceptions to the client via onError.

Quick Start

Create an endpoint method that returns or consumes Stream<T> with serializable types, then run serverpod generate to produce the client stubs and start listening to the resulting stream.