QVAC Logo

ping( )

Sends a ping request to the server and returns the pong response.

function ping(): Promise<{ type: "pong"; number: number }>;

Parameters

None.

Returns

Promise<{ type: "pong", number: number }> — The pong response containing a number.

Throws

ErrorWhen
INVALID_RESPONSE_TYPEResponse type does not match expected "pong"

Example

const pong = await ping();
console.log(pong.number);

On this page