Merge pull request #86 from tiagosiebler/heartbeatdisable

feat(v3.0.4): implement mechanism to disable heartbeat

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "bitget-api",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Complete Node.js & JavaScript SDK for Bitget V1-V3 REST APIs & WebSockets, with TypeScript & end-to-end tests.",
   "scripts": {
     "test": "jest",

package.json

@@ -186,7 +186,7 @@ export interface WSClientConfigurableOptions {
   /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
   recvWindow?: number;
 
-  // Disable ping/pong ws heartbeat mechanism (not recommended) // TODO:
+  // Disable ping/pong ws heartbeat mechanism (not recommended)
   disableHeartbeat?: boolean;
 
   /** How often to check if the connection is alive */

src/types/websockets/ws-general.ts

@@ -864,11 +864,13 @@ export abstract class BaseWebsocketClient<
 
     this.setWsState(wsKey, WsConnectionStateEnum.CONNECTED);
 
-    this.logger.trace('Enabled ping timer', { ...WS_LOGGER_CATEGORY, wsKey });
-    this.wsStore.get(wsKey, true)!.activePingTimer = setInterval(
-      () => this.ping(wsKey),
-      this.options.pingInterval,
-    );
+    if (!this.options.disableHeartbeat) {
+      this.logger.trace('Enabled ping timer', { ...WS_LOGGER_CATEGORY, wsKey });
+      this.wsStore.get(wsKey, true)!.activePingTimer = setInterval(
+        () => this.ping(wsKey),
+        this.options.pingInterval,
+      );
+    }
 
     // Resolve & cleanup deferred "connection attempt in progress" promise
     try {

src/util/BaseWSClient.ts

@@ -270,6 +270,7 @@ export function safeTerminateWs(
 
   return false;
 }
+
 /**
  * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
  *