@oeos-components/utils 0.0.19 → 0.0.22

package/dist/ws.d.cts

@@ -0,0 +1,86 @@
+/**
+ * setTimeout 类型
+ */
+type Timeout = ReturnType<typeof setTimeout>;
+/**
+ * setInterval 类型
+ */
+type Interval = ReturnType<typeof setInterval>;
+/**
+ * 允许null的泛型
+ */
+type Nullable<T> = T | null;
+type AutoReconnect = {
+    /**
+     *重连尝试次数 默认 3
+     */
+    reconnectMaxCount?: number;
+};
+type Heartbeat = {
+    /**
+     * 心跳信息 默认`ping`
+     */
+    message: string;
+    /**
+     * 心跳间隔时间 默认 `3000` 毫秒
+     */
+    interval: number;
+};
+interface WSOptions {
+    /**
+     * 是否自动重连 默认`true`
+     */
+    autoReconnect: boolean | AutoReconnect;
+    /**
+     * 心跳 默认`false`
+     */
+    heartbeat: boolean | Heartbeat;
+    /**
+     * url 携带的参数
+     */
+    query: Record<string, string>;
+}
+declare class WS {
+    url: string;
+    socket: WebSocket | null;
+    reconnectCount: number;
+    delay: Nullable<Timeout>;
+    timer: Nullable<Interval>;
+    autoReconnect: WSOptions["autoReconnect"];
+    heartbeat: WSOptions["heartbeat"];
+    query: WSOptions["query"];
+    constructor(url?: string, options?: WSOptions);
+    /**
+     * 连接
+     */
+    connect(): void;
+    /**
+     * 监听连接
+     */
+    onOpen(): void;
+    /**
+     * 开启心跳
+     */
+    startHeartbeat(): void;
+    /**
+     * 监听错误
+     */
+    onError(): void;
+    /**
+     * 关闭连接
+     */
+    close(): void;
+    /**
+     *  监听消息
+     * @param callback
+     */
+    onMessage(callback: (...data: any[]) => any): void;
+    /**
+     * 发送消息
+     * @param data
+     */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+}
+
+export { WS };
+export type { WSOptions };

package/dist/ws.d.mts

@@ -0,0 +1,86 @@
+/**
+ * setTimeout 类型
+ */
+type Timeout = ReturnType<typeof setTimeout>;
+/**
+ * setInterval 类型
+ */
+type Interval = ReturnType<typeof setInterval>;
+/**
+ * 允许null的泛型
+ */
+type Nullable<T> = T | null;
+type AutoReconnect = {
+    /**
+     *重连尝试次数 默认 3
+     */
+    reconnectMaxCount?: number;
+};
+type Heartbeat = {
+    /**
+     * 心跳信息 默认`ping`
+     */
+    message: string;
+    /**
+     * 心跳间隔时间 默认 `3000` 毫秒
+     */
+    interval: number;
+};
+interface WSOptions {
+    /**
+     * 是否自动重连 默认`true`
+     */
+    autoReconnect: boolean | AutoReconnect;
+    /**
+     * 心跳 默认`false`
+     */
+    heartbeat: boolean | Heartbeat;
+    /**
+     * url 携带的参数
+     */
+    query: Record<string, string>;
+}
+declare class WS {
+    url: string;
+    socket: WebSocket | null;
+    reconnectCount: number;
+    delay: Nullable<Timeout>;
+    timer: Nullable<Interval>;
+    autoReconnect: WSOptions["autoReconnect"];
+    heartbeat: WSOptions["heartbeat"];
+    query: WSOptions["query"];
+    constructor(url?: string, options?: WSOptions);
+    /**
+     * 连接
+     */
+    connect(): void;
+    /**
+     * 监听连接
+     */
+    onOpen(): void;
+    /**
+     * 开启心跳
+     */
+    startHeartbeat(): void;
+    /**
+     * 监听错误
+     */
+    onError(): void;
+    /**
+     * 关闭连接
+     */
+    close(): void;
+    /**
+     *  监听消息
+     * @param callback
+     */
+    onMessage(callback: (...data: any[]) => any): void;
+    /**
+     * 发送消息
+     * @param data
+     */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+}
+
+export { WS };
+export type { WSOptions };

package/dist/ws.d.ts

@@ -0,0 +1,86 @@
+/**
+ * setTimeout 类型
+ */
+type Timeout = ReturnType<typeof setTimeout>;
+/**
+ * setInterval 类型
+ */
+type Interval = ReturnType<typeof setInterval>;
+/**
+ * 允许null的泛型
+ */
+type Nullable<T> = T | null;
+type AutoReconnect = {
+    /**
+     *重连尝试次数 默认 3
+     */
+    reconnectMaxCount?: number;
+};
+type Heartbeat = {
+    /**
+     * 心跳信息 默认`ping`
+     */
+    message: string;
+    /**
+     * 心跳间隔时间 默认 `3000` 毫秒
+     */
+    interval: number;
+};
+interface WSOptions {
+    /**
+     * 是否自动重连 默认`true`
+     */
+    autoReconnect: boolean | AutoReconnect;
+    /**
+     * 心跳 默认`false`
+     */
+    heartbeat: boolean | Heartbeat;
+    /**
+     * url 携带的参数
+     */
+    query: Record<string, string>;
+}
+declare class WS {
+    url: string;
+    socket: WebSocket | null;
+    reconnectCount: number;
+    delay: Nullable<Timeout>;
+    timer: Nullable<Interval>;
+    autoReconnect: WSOptions["autoReconnect"];
+    heartbeat: WSOptions["heartbeat"];
+    query: WSOptions["query"];
+    constructor(url?: string, options?: WSOptions);
+    /**
+     * 连接
+     */
+    connect(): void;
+    /**
+     * 监听连接
+     */
+    onOpen(): void;
+    /**
+     * 开启心跳
+     */
+    startHeartbeat(): void;
+    /**
+     * 监听错误
+     */
+    onError(): void;
+    /**
+     * 关闭连接
+     */
+    close(): void;
+    /**
+     *  监听消息
+     * @param callback
+     */
+    onMessage(callback: (...data: any[]) => any): void;
+    /**
+     * 发送消息
+     * @param data
+     */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+}
+
+export { WS };
+export type { WSOptions };

package/dist/ws.mjs

@@ -0,0 +1,114 @@
+import qs from 'qs';
+
+const reconnectMaxCount = 3;
+const message = "ping";
+const interval = 3e3;
+const timeout = 1e3;
+class WS {
+  url;
+  socket = null;
+  reconnectCount = 0;
+  delay = null;
+  timer = null;
+  autoReconnect;
+  heartbeat;
+  query;
+  constructor(url, options) {
+    const { autoReconnect = true, query = {}, heartbeat = false } = options || {};
+    this.autoReconnect = autoReconnect;
+    this.heartbeat = heartbeat;
+    this.query = query;
+    this.url = `${url}` + qs.stringify({ ...this.query }, { addQueryPrefix: true });
+    this.connect();
+  }
+  /**
+   * 连接
+   */
+  connect() {
+    this.close();
+    this.socket = new WebSocket(this.url);
+    this.onError();
+    this.onOpen();
+  }
+  /**
+   * 监听连接
+   */
+  onOpen() {
+    if (this.socket) {
+      this.socket.onopen = () => {
+        this.send("ping");
+        this.heartbeat && this.startHeartbeat();
+      };
+    }
+  }
+  /**
+   * 开启心跳
+   */
+  startHeartbeat() {
+    const msg = this.heartbeat?.message || message;
+    const int = this.heartbeat?.interval || interval;
+    this.timer = setInterval(() => {
+      this.send(msg);
+    }, int);
+  }
+  /**
+   * 监听错误
+   */
+  onError() {
+    if (this.socket) {
+      this.socket.onerror = () => {
+        const count = this.autoReconnect?.reconnectMaxCount || reconnectMaxCount;
+        if (this.autoReconnect && this.reconnectCount < count) {
+          this.reconnectCount++;
+          this.connect();
+        }
+      };
+    }
+  }
+  /**
+   * 关闭连接
+   */
+  close() {
+    this.socket && this.socket.close();
+    this.delay && clearTimeout(this.delay);
+    this.timer && clearInterval(this.timer);
+    this.socket = null;
+  }
+  /**
+   *  监听消息
+   * @param callback
+   */
+  onMessage(callback) {
+    if (this.socket) {
+      this.socket.onmessage = (data) => {
+        try {
+          const res = JSON.parse(data.data);
+          callback(res);
+        } catch (err) {
+          callback(data);
+        }
+      };
+    }
+  }
+  /**
+   * 发送消息
+   * @param data
+   */
+  send(data) {
+    if (!this.socket) return;
+    if (this.socket.readyState === this.socket.OPEN) {
+      this.socket.send(JSON.stringify(data));
+    } else if (this.socket.readyState === this.socket.CONNECTING) {
+      this.delay = setTimeout(() => {
+        this.socket?.send(data);
+      }, timeout);
+    } else {
+      this.connect();
+      this.delay = setTimeout(() => {
+        this.socket?.send(data);
+      }, timeout);
+    }
+  }
+}
+
+export { WS };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oeos-components/utils",
-  "version": "0.0.19",
+  "version": "0.0.22",
   "description": "utils of oeos-components",
   "license": "MIT",
   "type": "commonjs",
@@ -25,9 +25,11 @@
     "@vue/reactivity": "^3.5.18",
     "@vue/shared": "^3.5.18",
     "consola": "^3.4.2",
+    "dayjs": "^1.11.19",
     "element-plus": "^2.11.5",
     "es-toolkit": "^1.39.10",
     "lodash-es": "^4.17.21",
+    "qs": "^6.15.0",
     "vue": "3.4.15"
   }
 }