react-realtime-hooks 1.4.3 → 2.0.1

package/README.md

@@ -3,6 +3,8 @@
 [![npm version](https://img.shields.io/npm/v/react-realtime-hooks?color=0f766e)](https://www.npmjs.com/package/react-realtime-hooks)
 [![Quality Gate](https://img.shields.io/github/actions/workflow/status/volkov85/react-realtime-hooks/quality-gate.yml?branch=main&label=quality%20gate)](https://github.com/volkov85/react-realtime-hooks/actions/workflows/quality-gate.yml)
 [![Demo](https://img.shields.io/github/actions/workflow/status/volkov85/react-realtime-hooks/pages.yml?branch=main&label=demo)](https://github.com/volkov85/react-realtime-hooks/actions/workflows/pages.yml)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/react-realtime-hooks?label=min%20%2B%20gzip&color=0f766e)](https://bundlephobia.com/package/react-realtime-hooks)
+[![dependencies](https://img.shields.io/badge/dependencies-zero-0f766e)](https://github.com/volkov85/react-realtime-hooks/blob/main/package.json)
 [![license](https://img.shields.io/npm/l/react-realtime-hooks)](https://github.com/volkov85/react-realtime-hooks/blob/main/LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-typed-3178c6)](https://www.typescriptlang.org/)
 [![react](https://img.shields.io/badge/react-18%20%7C%2019-149eca)](https://www.npmjs.com/package/react)
@@ -88,7 +90,6 @@ export function NotificationsPanel() {
     parseMessage: (event) => JSON.parse(String(event.data)) as IncomingMessage,
     reconnect: {
       initialDelayMs: 1_000,
-      maxAttempts: null,
     },
     heartbeat: {
       intervalMs: 10_000,
@@ -239,7 +240,6 @@ export function ChatSocket() {
     parseMessage: (event) => JSON.parse(String(event.data)) as IncomingMessage,
     reconnect: {
       initialDelayMs: 1_000,
-      maxAttempts: null,
     },
     heartbeat: {
       intervalMs: 10_000,
@@ -393,6 +393,8 @@ export function GatedNotifications() {
       initialDelayMs: 1_000,
       maxAttempts: null,
     },
+    // ^ pass `null` explicitly to opt back into unlimited reconnect attempts;
+    // the default in 2.0 caps retries at 10.
     url: "ws://localhost:8080/notifications",
   });
 
@@ -508,7 +510,7 @@ retry loop.
 | `maxDelayMs`     | `number`                 | `30000`     | Delay cap                            |
 | `backoffFactor`  | `number`                 | `2`         | Exponential multiplier               |
 | `jitterRatio`    | `number`                 | `0.2`       | Randomized variance ratio            |
-| `maxAttempts`    | `number \| null`         | `null`      | Max attempts, `null` means unlimited |
+| `maxAttempts`    | `number \| null`         | `10`        | Max attempts before `"stopped"`; pass `null` for unlimited |
 | `getDelayMs`     | `ReconnectDelayStrategy` | `undefined` | Custom delay strategy                |
 | `resetOnSuccess` | `boolean`                | `true`      | Resets attempt count after success   |
 | `onSchedule`     | `(attempt) => void`      | `undefined` | Called when an attempt is scheduled  |
@@ -540,7 +542,7 @@ retry loop.
 | -------------- | --------------------------------------------------- | ----------- | ------------------------------------------- |
 | `enabled`      | `boolean`                                           | `true`      | Enables the heartbeat loop                  |
 | `intervalMs`   | `number`                                            | Required    | Beat interval                               |
-| `timeoutMs`    | `number`                                            | `undefined` | Timeout before `hasTimedOut` becomes `true` |
+| `timeoutMs`    | `number \| null`                                    | `10_000`    | Timeout in ms before `hasTimedOut` becomes `true`; pass `null` to disable |
 | `message`      | `TOutgoing \| (() => TOutgoing)`                    | `undefined` | Optional heartbeat payload                  |
 | `beat`         | `() => void \| boolean \| Promise<void \| boolean>` | `undefined` | Custom beat side effect                     |
 | `matchesAck`   | `(message) => boolean`                              | `undefined` | Ack matcher                                 |
@@ -694,6 +696,12 @@ Run the local playground:
 npm run demo
 ```
 
+## Migrating from 1.x
+
+Two defaults change in 2.0 (`reconnect.maxAttempts` → `10`,
+`heartbeat.timeoutMs` → `10_000`). See [MIGRATING.md](./MIGRATING.md) for the
+exact diff and how to restore 1.x behaviour.
+
 ## Contributing
 
 Development and release workflow live in [CONTRIBUTING.md](./CONTRIBUTING.md).

package/dist/index.cjs

@@ -315,6 +315,7 @@ var DEFAULT_RECONNECT_OPTIONS = {
   enabled: true,
   initialDelayMs: 1e3,
   jitterRatio: 0.2,
+  maxAttempts: 10,
   maxDelayMs: 3e4,
   resetOnSuccess: true
 };
@@ -366,7 +367,7 @@ var normalizeReconnectOptions = (options) => {
     jitterRatio: sanitizeJitterRatio(
       options?.jitterRatio ?? DEFAULT_RECONNECT_OPTIONS.jitterRatio
     ),
-    maxAttempts: sanitizeMaxAttempts(options?.maxAttempts),
+    maxAttempts: options?.maxAttempts === void 0 ? DEFAULT_RECONNECT_OPTIONS.maxAttempts : sanitizeMaxAttempts(options.maxAttempts),
     maxDelayMs,
     resetOnSuccess: options?.resetOnSuccess ?? DEFAULT_RECONNECT_OPTIONS.resetOnSuccess
   };
@@ -584,6 +585,7 @@ var useReconnect = (options = {}) => {
     status: state.status
   };
 };
+var DEFAULT_HEARTBEAT_TIMEOUT_MS = 1e4;
 var createInitialState2 = (isRunning) => ({
   hasTimedOut: false,
   isRunning,
@@ -617,13 +619,14 @@ var useHeartbeat = (options) => {
     options.onTimeout?.();
   });
   const scheduleTimeout = useStableCallback(() => {
-    if (options.timeoutMs === void 0) {
+    const timeoutMs = options.timeoutMs === void 0 ? DEFAULT_HEARTBEAT_TIMEOUT_MS : options.timeoutMs;
+    if (timeoutMs === null) {
       timeoutRef.current.cancel();
       return;
     }
     timeoutRef.current.schedule(() => {
       handleTimeout();
-    }, options.timeoutMs);
+    }, timeoutMs);
   });
   const handleBeatSuccess = useStableCallback((performedAt) => {
     commitState((current) => ({
@@ -986,7 +989,7 @@ var useWebSocket = (options) => {
     startOnMount: false
   };
   if (heartbeatConfig !== null && heartbeatConfig.timeoutMs !== void 0) {
-    heartbeatHookOptions.timeoutMs = heartbeatConfig.timeoutMs;
+    heartbeatHookOptions.timeoutMs = heartbeatConfig.timeoutMs ?? null;
   }
   if (heartbeatConfig !== null && heartbeatConfig.matchesAck !== void 0) {
     heartbeatHookOptions.matchesAck = heartbeatConfig.matchesAck;