Setu-TS
    Preparing search index...

    Interface SsePluginOptions

    Options for the SsePlugin.

    0.1.0

    interface SsePluginOptions {
        diagnostics?: RealtimeDiagnosticsOptions;
        heartbeatMs?: number;
        retryMs?: number;
        scalingNotice?: boolean;
    }
    Index

    Opt-in realtime lifecycle observations for the local diagnostics connector (M98l). Absent (the default) registers an inert disabled source and observes nothing.

    When set, the plugin counts, under the one approved alias, how many streams opened and closed (closes caused by the backlog guard are counted separately) and how many frames were enqueued or refused, and reads the service's current connection and channel counts when a paired devtool asks. No message, comment, channel name, connection id, Last-Event-ID or request data is ever observed. Validated when SsePlugin(...) is called.

    0.8.0

    heartbeatMs?: number

    Heartbeat interval in milliseconds. When set, the plugin schedules a repeating : heartbeat\n\n comment frame. Omit to disable (no timer created).

    0.1.0

    retryMs?: number

    Reconnection time in milliseconds. When set, the first bytes on every new stream are retry: <ms> advertising the reconnect delay. Omit to send no retry: field.

    0.1.0

    scalingNotice?: boolean

    Whether to log one info line at registration when no realtime backplane is registered, stating that channels broadcast in-process only. Defaults to true.

    Set false to silence it — appropriate when you have decided single-replica fan-out is correct for this deployment and do not want the line on every startup. It suppresses only the message: channel delivery is unaffected either way, and the notice never appears once a backplane is registered.

    0.2.0