interface SsePluginOptions
Since 0.1.0

Options for the SsePlugin.

Properties

Since 0.1.0
readonly
optional
heartbeatMs: number

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

Since 0.1.0
readonly
optional
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.

Since 0.2.0
readonly
optional
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.

Usage

import { type SsePluginOptions } from "sse-plugin/src/index.ts";