@qy_better_lib/hooks 0.2.6 → 0.2.8

package/DOCUMENTATION.md

@@ -623,56 +623,7 @@ emitter.on('test', (data) => {
 emitter.off('test', listener);
 ```
 
-### 10. use-websocket - WebSocket功能
 
-#### 功能描述
-适用于需要在前端实现WebSocket通信的场景，支持自动重连、心跳检测、消息队列等功能。
-
-#### 参数
-- `options: WebSocketOptions` - WebSocket配置选项
-
-#### 返回值
-- **ws**: `WebSocket | undefined` - WebSocket实例
-- **create**: `() => void` - 创建连接
-- **close**: `() => void` - 关闭连接
-- **send_message**: `(msg: any) => boolean` - 发送消息
-- **get_status**: `() => WebSocketStatus` - 获取连接状态
-- **reconnect**: `() => void` - 重连
-- **start_heartbeat**: `() => void` - 启动心跳检测
-- **stop_heartbeat**: `() => void` - 停止心跳检测
-
-#### 示例
-```typescript
-import { use_web_socket } from '@qy_better_lib/hooks';
-
-const { create, close, send_message, get_status } = use_web_socket({
-  server: 'ws://localhost:8080',
-  receive: (event) => {
-    console.log('收到消息:', event.data);
-  },
-  on_open: () => {
-    console.log('连接成功');
-  },
-  on_error: (error) => {
-    console.error('连接错误:', error);
-  },
-  on_close: () => {
-    console.log('连接关闭');
-  },
-  auto_reconnect: true,
-  heartbeat_interval: 30000
-});
-
-// 发送消息
-send_message('Hello WebSocket');
-
-// 获取连接状态
-const status = get_status();
-console.log(status);
-
-// 关闭连接
-close();
-```
 
 ## 注意事项