reconnecting-websocket - npm Package Compare versions

Comparing version 1.3.2 to 1.4.0

build/index.js

@@ -136,5 +136,8 @@ "use strict";
     connect();
-    this.close = function () {
-        shouldRetry = false;
-        ws.close();
+    this.close = function (code, reason, keepClosed) {
+        if (code === void 0) { code = 1000; }
+        if (reason === void 0) { reason = ''; }
+        if (keepClosed === void 0) { keepClosed = false; }
+        shouldRetry = !keepClosed;
+        ws.close(code, reason);
     };
@@ -141,0 +144,0 @@ this.addEventListener = function (type, listener, options) {

index.ts

@@ -155,5 +155,5 @@ type Options = {
 
-    this.close = () => {
-        shouldRetry = false;
-        ws.close();
+    this.close = (code = 1000, reason = '', keepClosed = false) => {
+        shouldRetry = !keepClosed;
+        ws.close(code, reason);
     };
@@ -160,0 +160,0 @@

package.json

 {
   "name": "reconnecting-websocket",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Reconnecting WebSocket",
@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

@@ -67,3 +67,3 @@ # Reconnecting WebSocket
 const defaultOptions = {
-    constructor: (typeof WebSocket === 'function') ? WebSocket : null,
+    constructor: isGlobalWebSocket() ? WebSocket : null,
     maxReconnectionDelay: 10000,
@@ -87,2 +87,12 @@ minReconnectionDelay: 1500,
 
+#### Manually closing
+
+The `close` function has an additional optional parameter `keepClosed`.
+
+```javascript
+close(code = 1000, reason = '', keepClosed = false)
+```
+
+Use the `keepClosed` parameter to keep the WebSocket closed or automatically reconnect.
+
 #### Using alternative constructor
@@ -89,0 +99,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

70634

increased by1.92%

Lines of code

760

increased by0.4%

Number of lines in readme file

130

increased by8.33%

No dependency changes