Skip to main content

IQWebSocketHeartbeatOptions

@quik/websocket


@quik/websocket / IQWebSocketHeartbeatOptions

Interface: IQWebSocketHeartbeatOptions

Defined in: websocket/src/types.ts:46

Runtime heartbeat options.

Properties

enabled

enabled: boolean

Defined in: websocket/src/types.ts:48

Enables heartbeat checks.


intervalMilliseconds

intervalMilliseconds: number

Defined in: websocket/src/types.ts:50

Interval between pings.


pingMessageType

pingMessageType: string

Defined in: websocket/src/types.ts:54

Application-level ping message type.


pongMessageType

pongMessageType: string

Defined in: websocket/src/types.ts:56

Application-level pong message type.


timeoutMilliseconds

timeoutMilliseconds: number

Defined in: websocket/src/types.ts:52

Time allowed for a pong after a ping.