Skip to main content

createWebSocketPingMessage

@quik/websocket


@quik/websocket / createWebSocketPingMessage

Function: createWebSocketPingMessage()

createWebSocketPingMessage(type?, id?, timestamp?): string

Defined in: websocket/src/messages.ts:17

Creates a serialized heartbeat ping message.

Parameters

type?

string = "quik.websocket.ping"

Message type.

id?

string = ...

Optional heartbeat identifier.

timestamp?

number = ...

Optional timestamp.

Returns

string