feat(v1.5.6): add safeTerminate method with fallback for browsers

package.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "1.5.5",
+  "version": "1.5.6",
   "description": "Complete & robust Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/util/websocket-util.ts

@@ -329,3 +329,25 @@ export const WS_EVENT_CODE_ENUM = {
   LOGIN_FAILED: '60009',
   LOGIN_PARTIALLY_FAILED: '60022',
 };
+
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+export function safeTerminateWs(
+  ws?: WebSocket | any,
+  fallbackToClose?: boolean,
+): boolean {
+  if (!ws) {
+    return false;
+  }
+  if (typeof ws['terminate'] === 'function') {
+    ws.terminate();
+    return true;
+  } else if (fallbackToClose) {
+    ws.close();
+  }
+
+  return false;
+}

src/websocket-client.ts

@@ -35,6 +35,7 @@ import { signMessage } from './util/node-support';
 import {
   getWsKeyForMarket,
   getWsUrlForWsKey,
+  safeTerminateWs,
   WS_EVENT_CODE_ENUM,
   WsKey,
 } from './util/websocket-util';
@@ -196,7 +197,7 @@ export class WebsocketClient extends EventEmitter {
     const ws = this.wsStore.getWs(wsKey);
     ws?.close();
     if (force) {
-      ws?.terminate();
+      safeTerminateWs(ws);
     }
   }
 
@@ -484,8 +485,10 @@ export class WebsocketClient extends EventEmitter {
     });
 
     const wasOpen = this.wsStore.isWsOpen(wsKey);
+    if (wasOpen) {
+      safeTerminateWs(this.wsStore.getWs(wsKey), true);
+    }
 
-    this.wsStore.getWs(wsKey)?.terminate();
     delete this.wsStore.get(wsKey, true).activePongTimer;
     this.clearPingTimer(wsKey);
     this.clearPongTimer(wsKey);