property WebSocketRouteOptions.heartbeat
Since 0.3.0

Whether this route participates in the shared heartbeat sweep.

When false, the HeartbeatSweeper skips this route's connections for both the payload send and the idle eviction. Use this when the route speaks its own liveness protocol (e.g. graphql-transport-ws ping/pong) that would be corrupted by a generic text heartbeat.

Defaults to true so existing routes are unaffected.

Type

boolean

Usage

import { type WebSocketRouteOptions } from "common/src/index.ts";