Merge pull request #10 from revu-design/add-onreconnectstop

Add onReconnectStop callback as per react-usewebsocket

Author: Sumit1993

README.md

@@ -309,6 +309,7 @@ interface Options {
     onClose ? : (event: WebSocketEventMap['close']) => void;
     onMessage ? : (event: WebSocketEventMap['message']) => void;
     onError ? : (event: WebSocketEventMap['error']) => void;
+    onReconnectStop?: (numAttempts: number) => void;
     fromSocketIO ? : boolean;
     queryParams ? : {
         [key: string]: string | number;
@@ -339,7 +340,8 @@ Number of milliseconds to wait until it attempts to reconnect. Default is 5000.
 
 Each of `Options#onMessage`, `Options#onError`, `Options#onClose`, and `Options#onOpen` will be called on the corresponding WebSocket event, if provided. Each will be passed the same event provided from the WebSocket.
 
-  
+### onReconnectStop
+If provided in options, will be called when websocket exceeds reconnect limit, either as provided in the options or the default value of 20.  
 
 ### share: Boolean
 

src/lib/attach-listener.ts

@@ -47,6 +47,7 @@ export const attachListeners = (
           reconnect();
         }, optionsRef.current.reconnectInterval ?? DEFAULT_RECONNECT_INTERVAL_MS);
       } else {
+        optionsRef.current.onReconnectStop && optionsRef.current.onReconnectStop(reconnectAttempts);
         console.error(`Max reconnect attempts of ${reconnectAttempts} exceeded`);
       }
     }
@@ -60,6 +61,9 @@ export const attachListeners = (
           reconnectCount.current++;
           reconnect();
         }, optionsRef.current.reconnectInterval ?? DEFAULT_RECONNECT_INTERVAL_MS);
+      } else {
+        optionsRef.current.onReconnectStop && optionsRef.current.onReconnectStop(optionsRef.current.reconnectAttempts as number);
+        console.error(`Max reconnect attempts of ${optionsRef.current.reconnectAttempts} exceeded`);
       }
     }
   };

src/lib/attach-shared-listeners.ts

@@ -51,6 +51,7 @@ export const attachSharedListeners = (
             }, subscriber.optionsRef.current.reconnectInterval ?? DEFAULT_RECONNECT_INTERVAL_MS);
           }
         } else {
+          subscriber.optionsRef.current.onReconnectStop && subscriber.optionsRef.current.onReconnectStop(subscriber.optionsRef.current.reconnectAttempts as number);
           console.error(`Max reconnect attempts of ${reconnectAttempts} exceeded`);
         }
       }

src/lib/types.ts

@@ -20,6 +20,7 @@ export interface Options {
   onClose?: (event: WebSocketEventMap['close']) => void;
   onMessage?: (event: WebSocketEventMap['message']) => void;
   onError?: (event: WebSocketEventMap['error']) => void;
+  onReconnectStop?: (numAttempts: number) => void;
   shouldReconnect?: (event: WebSocketEventMap['close']) => boolean;
   reconnectInterval?: number;
   reconnectAttempts?: number;