reconnecting-websocket - npm Package Compare versions

Comparing version 3.0.7 to 3.1.0

dist/index.d.ts

@@ -1,2 +0,2 @@
-declare const ReconnectingWebsocket: (url: string, protocols?: string | string[], options?: {
+declare const ReconnectingWebsocket: (url: string | (() => string), protocols?: string | string[], options?: {
     constructor?: new (url: string, protocols?: string | string[]) => WebSocket;
@@ -3,0 +3,0 @@ maxReconnectionDelay?: number;

dist/index.js

@@ -117,3 +117,4 @@ "use strict";
         var oldWs = ws;
-        ws = new config.constructor(url, protocols);
+        var wsUrl = (typeof url === 'function') ? url() : url;
+        ws = new config.constructor(wsUrl, protocols);
         connectingTimeout = setTimeout(function () {
@@ -120,0 +121,0 @@ log('timeout');

dist/reconnecting-websocket.amd.d.ts

 declare module "index" {
-    const ReconnectingWebsocket: (url: string, protocols?: string | string[], options?: {
+    const ReconnectingWebsocket: (url: string | (() => string), protocols?: string | string[], options?: {
         constructor?: new (url: string, protocols?: string | string[]) => WebSocket;
@@ -4,0 +4,0 @@ maxReconnectionDelay?: number;

dist/reconnecting-websocket.amd.js

@@ -118,3 +118,4 @@ define("index", ["require", "exports"], function (require, exports) {
             var oldWs = ws;
-            ws = new config.constructor(url, protocols);
+            var wsUrl = (typeof url === 'function') ? url() : url;
+            ws = new config.constructor(wsUrl, protocols);
             connectingTimeout = setTimeout(function () {
@@ -121,0 +122,0 @@ log('timeout');

index.ts

@@ -66,3 +66,3 @@ /*!
 const ReconnectingWebsocket = function(
-    url: string,
+    url: string | (() => string),
     protocols?: string|string[],
@@ -138,3 +138,4 @@ options = <Options>{}
         const oldWs = ws;
-        ws = new (<any>config.constructor)(url, protocols);
+        const wsUrl = (typeof url === 'function') ? url() : url;
+        ws = new (<any>config.constructor)(wsUrl, protocols);
 
@@ -141,0 +142,0 @@ connectingTimeout = setTimeout(() => {

package.json

 {
   "name": "reconnecting-websocket",
-  "version": "3.0.7",
+  "version": "3.1.0",
   "description": "Reconnecting WebSocket",
@@ -30,10 +30,10 @@ "main": "dist/index.js",
   "devDependencies": {
-    "ava": "^0.20.0",
+    "ava": "^0.21.0",
     "coveralls": "^2.13.1",
-    "html5-websocket": "^1.0.0",
-    "nyc": "^11.0.3",
+    "html5-websocket": "^2.0.0",
+    "nyc": "^11.1.0",
     "opn-cli": "^3.1.0",
     "rimraf": "^2.5.4",
-    "typescript": "^2.4.1",
-    "ws": "^3.0.0"
+    "typescript": "^2.4.2",
+    "ws": "^3.1.0"
   },
@@ -40,0 +40,0 @@ "dependencies": {},

README.md

@@ -20,4 +20,5 @@ # Reconnecting WebSocket
 - Debug mode
-- Fast close (new in version 3)
+- Fast close
 - AMD build available (see dist folder)
+- Allows changing server URL
 
@@ -65,2 +66,17 @@ ## Install
 
+### Update URL
+
+The `url` parameter also accepts a `function` so you have a chance to update the URL before connecting:
+```
+const ReconnectingWebSocket = require('reconnecting-websocket');
+
+const urls = ['ws://my.site.com', 'ws://your.site.com', 'ws://their.site.com'];
+let urlIndex = 0;
+
+// Round robin url provider
+const getUrl = () => urls[urlIndex++ % urls.length];
+
+const rws = new ReconnectingWebSocket(getUrl);
+```
+
 ### Configure
@@ -67,0 +83,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

33126

increased by2.11%

Lines of code

661

increased by0.46%

Number of lines in readme file

164

increased by10.81%

No dependency changes