react-realtime-hooks 1.4.3 → 2.0.0

package/dist/index.d.cts

@@ -76,6 +76,11 @@ interface ReconnectDelayContext {
 type ReconnectDelayStrategy = (context: ReconnectDelayContext) => number;
 interface UseReconnectOptions {
     enabled?: boolean;
+    /**
+     * Maximum number of reconnect attempts before the hook gives up and
+     * transitions to `"stopped"`. Default is `10` (changed from `null` in
+     * 2.0). Pass `null` explicitly to retry indefinitely.
+     */
     maxAttempts?: number | null;
     initialDelayMs?: number;
     maxDelayMs?: number;
@@ -107,7 +112,12 @@ type HeartbeatAckMatcher<TMessage> = (message: TMessage) => boolean;
 interface UseHeartbeatOptions<TOutgoing = unknown, TIncoming = TOutgoing> {
     enabled?: boolean;
     intervalMs: number;
-    timeoutMs?: number;
+    /**
+     * Time to wait for an ack after a beat before flipping `hasTimedOut` to
+     * `true`. Default is `10_000` (10 seconds), changed from no default in
+     * 2.0. Pass `null` explicitly to disable the timeout entirely.
+     */
+    timeoutMs?: number | null;
     message?: TOutgoing | (() => TOutgoing);
     beat?: HeartbeatBeatFn;
     matchesAck?: HeartbeatAckMatcher<TIncoming>;

package/dist/index.d.ts

@@ -76,6 +76,11 @@ interface ReconnectDelayContext {
 type ReconnectDelayStrategy = (context: ReconnectDelayContext) => number;
 interface UseReconnectOptions {
     enabled?: boolean;
+    /**
+     * Maximum number of reconnect attempts before the hook gives up and
+     * transitions to `"stopped"`. Default is `10` (changed from `null` in
+     * 2.0). Pass `null` explicitly to retry indefinitely.
+     */
     maxAttempts?: number | null;
     initialDelayMs?: number;
     maxDelayMs?: number;
@@ -107,7 +112,12 @@ type HeartbeatAckMatcher<TMessage> = (message: TMessage) => boolean;
 interface UseHeartbeatOptions<TOutgoing = unknown, TIncoming = TOutgoing> {
     enabled?: boolean;
     intervalMs: number;
-    timeoutMs?: number;
+    /**
+     * Time to wait for an ack after a beat before flipping `hasTimedOut` to
+     * `true`. Default is `10_000` (10 seconds), changed from no default in
+     * 2.0. Pass `null` explicitly to disable the timeout entirely.
+     */
+    timeoutMs?: number | null;
     message?: TOutgoing | (() => TOutgoing);
     beat?: HeartbeatBeatFn;
     matchesAck?: HeartbeatAckMatcher<TIncoming>;

package/dist/index.js

@@ -313,6 +313,7 @@ var DEFAULT_RECONNECT_OPTIONS = {
   enabled: true,
   initialDelayMs: 1e3,
   jitterRatio: 0.2,
+  maxAttempts: 10,
   maxDelayMs: 3e4,
   resetOnSuccess: true
 };
@@ -364,7 +365,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
   };
@@ -582,6 +583,7 @@ var useReconnect = (options = {}) => {
     status: state.status
   };
 };
+var DEFAULT_HEARTBEAT_TIMEOUT_MS = 1e4;
 var createInitialState2 = (isRunning) => ({
   hasTimedOut: false,
   isRunning,
@@ -615,13 +617,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) => ({
@@ -984,7 +987,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;