Setu-TS
    Preparing search index...

    Interface RealtimeArm

    The real-time arm: one option grouping the three plugins that together make a connection-oriented application work, each added only when its sub-arm is present.

    Grouped rather than flattened into three unrelated-looking top-level options so the real-time story stays discoverable as a unit. realtime: {} adds nothing and is not an error.

    const app = createRestApp({
      realtime: {
        websocket: { routes: [] },
        backplane: { transport: 'redis', url: 'redis://localhost:6379' },
      },
    });

    RestStarterOptions.realtime

    interface RealtimeArm {
        backplane?: RealtimeBackplanePluginOptions;
        sse?: SsePluginOptions;
        websocket?: WebSocketPluginOptions;
    }
    Index
    backplane? sse? websocket?
    backplane?: RealtimeBackplanePluginOptions

    Options for RealtimeBackplanePlugin, which fans WebSocket rooms and SSE channels out across replicas. Present → the plugin is registered at PLUGIN_PRIORITY.HIGH, so it precedes both consumers.

    Absent → the WebSocket and SSE plugins emit their scaling notice, because their broadcast membership stays in-process.

    {} selects the 'memory' transport, whose discriminant is optional. { transport: 'messaging' } requires a MessagingPlugin in the same application — the microservice and full-stack tiers supply one; on the REST tier the backplane's own register() throws naming it.

    sse?: SsePluginOptions

    Options for SsePlugin. Present → the plugin is registered.

    websocket?: WebSocketPluginOptions

    Options for WebSocketPlugin. Present → the plugin is registered.

    On Node and Bun a WebSocket upgrade needs a real listening server, so the plugin registers with available: false under app.inject(); the same application code is correct on Deno and Cloudflare Workers.

    Settings
    Member Visibility

    On This Page
    Properties