@larksuiteoapi/node-sdk 1.57.0 → 1.58.0

package/es/index.js

@@ -85571,6 +85571,35 @@ class WSClient {
     getReconnectInfo() {
         return this.reconnectInfo;
     }
+    /**
+     * close connection
+     * @param params close params
+     * @param params.force whether force close (use terminate instead of close)
+     */
+    close(params = {}) {
+        const { force = false } = params;
+        if (this.pingInterval) {
+            clearTimeout(this.pingInterval);
+            this.pingInterval = undefined;
+        }
+        if (this.reconnectInterval) {
+            clearTimeout(this.reconnectInterval);
+            this.reconnectInterval = undefined;
+        }
+        this.isConnecting = false;
+        const wsInstance = this.wsConfig.getWSInstance();
+        if (wsInstance) {
+            wsInstance.removeAllListeners();
+            if (force) {
+                wsInstance.terminate();
+            }
+            else {
+                wsInstance.close();
+            }
+            this.wsConfig.setWSInstance(null);
+        }
+        this.logger.info('[ws]', `ws client closed manually${force ? ' (force)' : ''}`);
+    }
     start(params) {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.info('[ws]', `receive events or callbacks through persistent connection only available in self-build & Feishu app, Configured in:

package/lib/index.js

@@ -85586,6 +85586,35 @@ class WSClient {
     getReconnectInfo() {
         return this.reconnectInfo;
     }
+    /**
+     * close connection
+     * @param params close params
+     * @param params.force whether force close (use terminate instead of close)
+     */
+    close(params = {}) {
+        const { force = false } = params;
+        if (this.pingInterval) {
+            clearTimeout(this.pingInterval);
+            this.pingInterval = undefined;
+        }
+        if (this.reconnectInterval) {
+            clearTimeout(this.reconnectInterval);
+            this.reconnectInterval = undefined;
+        }
+        this.isConnecting = false;
+        const wsInstance = this.wsConfig.getWSInstance();
+        if (wsInstance) {
+            wsInstance.removeAllListeners();
+            if (force) {
+                wsInstance.terminate();
+            }
+            else {
+                wsInstance.close();
+            }
+            this.wsConfig.setWSInstance(null);
+        }
+        this.logger.info('[ws]', `ws client closed manually${force ? ' (force)' : ''}`);
+    }
     start(params) {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.info('[ws]', `receive events or callbacks through persistent connection only available in self-build & Feishu app, Configured in:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.57.0",
+  "version": "1.58.0",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

package/types/index.d.ts

@@ -293072,6 +293072,14 @@ declare class WSClient {
         lastConnectTime: number;
         nextConnectTime: number;
     };
+    /**
+     * close connection
+     * @param params close params
+     * @param params.force whether force close (use terminate instead of close)
+     */
+    close(params?: {
+        force?: boolean;
+    }): void;
     start(params: {
         eventDispatcher: EventDispatcher;
     }): Promise<void>;