isHeartbeatPingFrame

isHeartbeatPingFrame(value): boolean

Defined in: packages/connectors/src/heartbeat-frame.ts:65

True if value is a parsed heartbeat.ping frame.

value must already be the result of JSON.parse on the raw wire string — this does not parse JSON itself, so passing the raw string (e.g. HEARTBEAT_PING_FRAME) always returns false.

Parameters

value

unknown

Returns

boolean

Example

const parsed: unknown = JSON.parse(rawMessage);
if (isHeartbeatPingFrame(parsed)) {
  respondWithPong();
}