🔖 v0.0.1-1

Author: coderlzw-cn

.npmrc

@@ -1,110 +1,93 @@
 # 介绍
 
-`ClientWs` 是一个灵活且功能丰富的 `WebSocket` 客户端类，用于与 `WebSocket` 服务器进行通信。它支持自动重连、消息缓存和事件监听等功能
+`@coderlzw/ws` 是一个灵活且功能丰富的 `WebSocket` 客户端(`node`、`browser`)类，用于与 `WebSocket` 服务器进行通信。它支持自动重连、消息缓存和事件监听等功能
 
 # 安装
 
 ```shell
-npm add @coderlzw/client-ws
+npm add @coderlzw/ws
 // or
-yarn add @coderlzw/client-ws
+yarn add @coderlzw/ws
 // or
-pnpm add @coderlzw/client-ws
+pnpm add @coderlzw/ws
 ```
 
-# 使用
-
-```ts
-import ClientWs from '@coderlzw/client-ws';
-
-const wsClient = new ClientWs({
-  url: 'wss://example.com/socket', // WebSocket 服务器地址
-  timeout: 5000, // 可选，连接超时时间（毫秒）
-  reconnect: true, //可选，是否自动重连，默认为 true
-  reconnectInterval: 5000, //可选， 重连间隔（毫秒），默认为 5000
-  reconnectMaxInterval: 10000, // 可选，最大重连间隔（毫秒），默认为 10000
-  reconnectMaxTimes: 10, // 可选，最大重连次数，默认为 10
-  uniqueKey: 'message_id', // 消息唯一标识符，。默认值为 message_id
-  cacheMessage: true, // 是否缓存未发送的消息，默认值为 false
-  maxCacheMessage: 100 // 缓存消息的最大数量，默认值为 100
-});
-
-// 连接到 WebSocket 服务器
-wsClient.connect();
-
-// 监听事件
-wsClient.on('open', (event) => {
-  console.log('WebSocket 连接已打开', event);
-});
+# WebSocketClient
+
+## 特性
+
+-   支持自动重连
+-   消息缓存机制
+-   支持发送和接收二进制数据
+-   事件监听机制
+
+## 用法
+
+```javascript
+import { WebSocketClient } from "@coderlzw/ws";
+
+const ws = new WebSocketClient("ws://127.0.0.1:8080");
+// 需要调用 connect 才会建立连接
+ws.connect();
+ws.on("open", (event) => {
+    // ...
+})
+    .on("close", (closeEvent) => {
+        // ...
+    })
+    .on("error", (event) => {
+        // ...
+    })
+    .on("message", (messageEvent) => {
+        // ...
+    });
+```
 
-wsClient.on('message', (event) => {
-  console.log('收到消息:', event.data);
-});
+### 发送消息
 
-wsClient.on('close', (event) => {
-  console.log('WebSocket 连接已关闭', event);
-});
+```ts
+/// 无回调函数
+ws.sendMessage("hello");
 
-wsClient.on('error', (event) => {
-  console.error('WebSocket 错误:', event);
+// 有回调函数
+ws.sendMessage<{ name: string }>({ name: "张三" }, (error, data) => {
+    // error: null
+    // data: { name: "张三", message_id: "xxxxx" }
 });
 
-// 发送消息
-wsClient.sendMessage({ text: 'Hello, World!' }, (error, response) => {
-  if (error) {
-    console.error('消息发送失败:', error);
-  } else {
-    console.log('消息发送成功:', response);
-  }
+// 异步
+ws.sendMessageAsync<{ name: string }>({ name: "张三" }).then((data) => {
+    // data: { name: "张三", message_id: "xxxxx"}
 });
+```
 
-// 使用异步发送消息
-wsClient.sendMessageAsync({ text: 'Hello, Async!' })
-  .then(response => {
-    console.log('异步消息发送成功:', response);
-  })
-  .catch(error => {
-    console.error('异步消息发送失败:', error);
-  });
-
-// 关闭连接
-wsClient.close();
+# WebSocketServer
 
-// 销毁客户端
-wsClient.destroy();
+```ts
+import { WebSocketServer } from "@coderlzw/ws";
+
+const ws = new WebSocketServer("ws://localhost:8080");
+
+ws.connect();
+
+ws.on("open", (instance) => {
+    console.log("open", instance);
+})
+    .on("error", (instance, err) => {
+        console.log("error", err);
+    })
+    .on("close", (instance, code, reason) => {
+        console.log("close", event);
+    })
+    .on("message", (instance, data, isBinary) => {
+        console.log("message", data, isBinary);
+    });
 ```
 
-# 方法
-
-- `connect()`: 连接到 WebSocket 服务器。
-- `sendMessage<R = any, S = any>(data: S, callback?: MessageCallback<R>)`: 发送消息。如果 `WebSocket` 未连接且
-  `cacheMessage`
-  选项为 true，则消息会被缓存。`data` 可以是字符串或对象。
-- `sendMessageAsync<R = any, S = any>(data: S): Promise<R>`: 发送消息并返回一个 Promise。
-- `close()`: 关闭 WebSocket 连接。
-- `destroy()`: 销毁 WebSocket 客户端，移除所有监听器并关闭连接。
-- `on(event: string, listener: SocketEventListener)`: 添加事件监听器。支持的事件包括 `open`、`close`、`message` 和 `error`。
-- `once(event: string, listener: SocketEventListener)`: 添加一个一次性事件监听器。
-- `removeListener(event: string)`: 移除指定事件的所有监听器。
-- `removeAllListeners()`: 移除所有事件监听器。
-
-# 配置选项（Options）
-
-- `url: string`：WebSocket 服务器地址。必需。
-- `timeout?: number`：连接超时时间（毫秒），默认 `5000`。
-- `reconnect?: boolean`：是否自动重连，默认 `true`。
-- `reconnectInterval?: number`：重连间隔（毫秒），默认 `5000`。
-- `reconnectMaxInterval?: number`：最大重连间隔（毫秒），默认 `10000`。
-- `reconnectMaxTimes?: number`：最大重连次数，默认为 0 不限制。
-- `uniqueKey?: string`：每条消息携带的唯一标识符，默认为 `message_id`。
-- `cacheMessage?: boolean`：是否缓存发送失败的消息，默认为 `false`。
-- `maxCacheMessage?: number`：缓存消息的最大数量，默认为 `100`。
-
 # 贡献
 
-如果你希望为这个项目做出贡献，请在 GitHub 上提交 [Issues](https://github.com/coderlzw-cn/client-ws/issues)
-或 [Pull Requests](https://github.com/coderlzw-cn/client-ws/pulls)。
+如果你希望为这个项目做出贡献，请在 GitHub 上提交 [Issues](https://github.com/coderlzw-cn/client-ws/issues) 或 [Pull Requests](https://github.com/coderlzw-cn/client-ws/pulls)。
 
 # 许可证
 
-该项目使用 MIT 许可证 - 详情请参阅 [LICENSE](https://github.com/coderlzw-cn/client-ws/blob/main/LICENSE) 文件。
+该项目使用 MIT 许可证 - 详情请参阅 [LICENSE](https://github.com/coderlzw-cn/client-ws/blob/main/LICENSE) 文件。

README.md

@@ -12,19 +12,14 @@ export default [
     ...tseslint.configs.recommended,
     {
         rules: {
-            // 警告未使用的变量，但忽略以 "_" 开头的变量
-            "no-unused-vars": ["warn", {"varsIgnorePattern": "^_", "argsIgnorePattern": "^_"}],
-            // 如果有超过 1 行的连续空行则报错
+            "@typescript-eslint/no-unused-vars": ["warn", {"varsIgnorePattern": "^_", "argsIgnorePattern": "^_"}],
             "no-multiple-empty-lines": ["error", { "max": 1 }],
-            // 如果行尾有空格则报错
             "no-trailing-spaces": "error",
-            // 强制在语句末尾使用分号
             "semi": ["error", "always"],
-            // 强制使用双引号
             "quotes": ["error", "double"],
-            // 禁止在对象和数组的最后一个元素后面使用逗号
             "comma-dangle": ["error", "never"],
-            "@typescript-eslint/no-explicit-any": "off"
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-unsafe-function-type": "off"
         }
     }
 ];

eslint.config.mjs

@@ -1,18 +1,22 @@
 {
-  "name": "@coderlzw/client-ws",
-  "version": "0.0.1-beta.1",
-  "description": "封装浏览器端的 websocket",
-  "main": "dist/index.esm.js",
-  "types": "dist/types/index.d.ts",
+  "name": "@coderlzw/ws",
+  "version": "0.0.1-1",
+  "description": "对浏览器端的 WebSocket 和 ws 库的封装的客户端操作，支持重连等操作",
   "author": "梁志伟",
   "license": "MIT",
-  "homepage": "https://github.com/coderlzw-cn/client-ws#readme",
+  "homepage": "https://github.com/coderlzw-cn/websocket#readme",
   "keywords": [
-    "websocket"
+    "websocket",
+    "ws"
   ],
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/coderlzw-cn/client-ws"
+    "url": "https://github.com/coderlzw-cn/websocket"
   },
   "scripts": {
     "build": "rollup -c",
@@ -30,13 +34,20 @@
     "@eslint/js": "^9.8.0",
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@types/node": "^22.7.9",
+    "@types/ws": "^8.5.12",
     "eslint": "~9.8.0",
     "globals": "^15.9.0",
-    "rollup": "^4.20.0",
+    "rollup": "4.22.4",
     "rollup-plugin-cleaner": "^1.0.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-polyfill-node": "^0.13.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.36.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.0.1"
+  },
+  "dependencies": {
+    "ws": "^8.18.0"
   }
 }