@zero-library/common 2.5.0 → 3.0.1

package/dist/index.d.mts

@@ -831,16 +831,9 @@ declare const _default$1: <A extends Array<any>, R = void>(func: (..._args: A) =
     cancel: () => void;
 };
 
-/**
- * useWebSocket Hook 参数类型定义
- */
-interface WebSocketProps {
+interface WebSocketManagerOptions {
     /** WebSocket 服务器地址 */
     url: string;
-    /** 接收到消息时的回调函数 */
-    onMessage: (message: any) => void;
-    /** 连接关闭时的回调函数（可选） */
-    onClose?: () => void;
     /** 心跳间隔时间，单位毫秒，默认 30000ms */
     heartbeatInterval?: number;
     /** 心跳消息内容，默认 'ping' */
@@ -854,6 +847,16 @@ interface WebSocketProps {
     /** 是否开启重连机制，默认 true */
     isReconnect?: boolean;
 }
+
+/**
+ * useWebSocket Hook 参数类型定义
+ */
+interface WebSocketProps extends WebSocketManagerOptions {
+    /** 接收到消息时的回调函数 */
+    onMessage: (message: any) => void;
+    /** 连接关闭时的回调函数（可选） */
+    onClose?: () => void;
+}
 /**
  * useWebSocket Hook 返回值类型定义
  */
@@ -872,6 +875,14 @@ interface WebSocketType {
  * - 页面可见性监听
  * - 连接状态管理
  * - 消息发送与接收
+ * - 多组件共享连接（相同 url 多次调用只会创建一个连接）
+ *
+ * 使用说明：
+ * - 相同 `url` 的多个组件会复用同一个 `WebSocketManager` 和底层连接
+ * - 断线重连时会重新创建底层 `WebSocket`，但已注册的组件监听器会继续保留
+ * - `onMessage` 和 `onClose` 通过 `ref` 持有最新引用，组件重渲染后无需重新建立连接
+ * - 当前 Hook 仅在 `url` 变化时重新订阅；同一 `url` 下修改心跳、重连等配置不会立即更新已存在的管理器实例
+ * - 组件卸载或 `url` 变化时会移除当前监听器；当某个 `url` 没有任何订阅者后，连接会在短暂缓冲后销毁
  *
  * @example
  * ```tsx

package/dist/index.d.ts

@@ -831,16 +831,9 @@ declare const _default$1: <A extends Array<any>, R = void>(func: (..._args: A) =
     cancel: () => void;
 };
 
-/**
- * useWebSocket Hook 参数类型定义
- */
-interface WebSocketProps {
+interface WebSocketManagerOptions {
     /** WebSocket 服务器地址 */
     url: string;
-    /** 接收到消息时的回调函数 */
-    onMessage: (message: any) => void;
-    /** 连接关闭时的回调函数（可选） */
-    onClose?: () => void;
     /** 心跳间隔时间，单位毫秒，默认 30000ms */
     heartbeatInterval?: number;
     /** 心跳消息内容，默认 'ping' */
@@ -854,6 +847,16 @@ interface WebSocketProps {
     /** 是否开启重连机制，默认 true */
     isReconnect?: boolean;
 }
+
+/**
+ * useWebSocket Hook 参数类型定义
+ */
+interface WebSocketProps extends WebSocketManagerOptions {
+    /** 接收到消息时的回调函数 */
+    onMessage: (message: any) => void;
+    /** 连接关闭时的回调函数（可选） */
+    onClose?: () => void;
+}
 /**
  * useWebSocket Hook 返回值类型定义
  */
@@ -872,6 +875,14 @@ interface WebSocketType {
  * - 页面可见性监听
  * - 连接状态管理
  * - 消息发送与接收
+ * - 多组件共享连接（相同 url 多次调用只会创建一个连接）
+ *
+ * 使用说明：
+ * - 相同 `url` 的多个组件会复用同一个 `WebSocketManager` 和底层连接
+ * - 断线重连时会重新创建底层 `WebSocket`，但已注册的组件监听器会继续保留
+ * - `onMessage` 和 `onClose` 通过 `ref` 持有最新引用，组件重渲染后无需重新建立连接
+ * - 当前 Hook 仅在 `url` 变化时重新订阅；同一 `url` 下修改心跳、重连等配置不会立即更新已存在的管理器实例
+ * - 组件卸载或 `url` 变化时会移除当前监听器；当某个 `url` 没有任何订阅者后，连接会在短暂缓冲后销毁
  *
  * @example
  * ```tsx