Server API
Realtime class, handle function, channels, and emitting events.
The server API is the core of forrealtime. It provides the Realtime class, the handle function to create SSE endpoints, channels for scoping events, and utility types for type inference.
- Realtime — The core class that owns your schema, Redis adapter, and history settings
- handle — Convert a Realtime instance into an SSE endpoint
- Emitting Events — Send events to the default channel or a specific channel
- Channels — Scope events to specific groups of subscribers
- InferRealtimeEvents — Extract inferred event payload types