interface HeartbeatOptions
Since 0.1.0

Configuration for the sweeper.

Properties

readonly
heartbeatMs: number

Tick interval in milliseconds; 0 disables the sweeper entirely.

readonly
heartbeatPayload: string

The text frame sent on each tick.

readonly
idleTimeoutMs: number

Inbound silence in milliseconds after which a connection is closed; 0 disables.

Usage

import { type HeartbeatOptions } from "websocket-plugin/src/index.ts";