Skip to main content

Configuration

Default configuration keys for @quik/websocket. See the generated Config Keys and Environment Variables tables for the full list.

  • websocket.path (WEBSOCKET_PATH) — HTTP upgrade path used by WebSocket adapters. Defaults to /ws.
  • websocket.heartbeat.enabled (WEBSOCKET_HEARTBEAT_ENABLED) — enables server-side heartbeat checks. Defaults to true.
  • websocket.heartbeat.intervalMilliseconds (WEBSOCKET_HEARTBEAT_INTERVAL_MILLISECONDS) — interval between heartbeat pings. Defaults to 30000.
  • websocket.heartbeat.timeoutMilliseconds (WEBSOCKET_HEARTBEAT_TIMEOUT_MILLISECONDS) — time allowed for a peer to answer the latest ping before it's considered dead. Defaults to 10000.
  • websocket.heartbeat.pingMessageType / pongMessageType — application-level message type strings used for heartbeat frames. Default to quik.websocket.ping / quik.websocket.pong.

@quik/websocket defines the IQWebSocketEngine adapter contract but does not implement a server on its own — pair it with an adapter package such as @quik/websocket-express.