# websocket-operator

**Repository Path**: Ann-yang/websocket-operator

## Basic Information

- **Project Name**: websocket-operator
- **Description**: 简单的封装了websocket, 支持自动心跳, 错误重连
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-04-19
- **Last Updated**: 2024-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 安装

```sh
npm install @anlib/websocket-operator --save
```

## 使用

```js
import WebSocketOperator from "@anlib/websocket-operator";

// 检测是否支持 websocket
WebSocketOperator.isCompatibleWebSocket().then(res => {

  const wsOperator = new WebSocketOperator({
    url: "ws:localhost:8888/ws-test",
    heartbeatInterval: 1000, // 心跳间隔
    heartbeatData: "ping", // 心跳回应数据, 需要配合 heartbeatResult
    heartbeatResult: "pone", // 服务端心跳回应的值
    reconnectInterval: 1500, // 重试间隔
    maxReconnectionNum: -1, // 无限重试
    // maxReconnectionNum: 10,
    isSpeedUp: false, // 不会重试加快
  });

  setTimeout(() => {
    wsOperator.heartbeatData = "我变了";

    // 错误写法, 不会更新
    // wsOperator.option.heartbeatInterval = 3000;

    // 正确写法, 会更新心跳频率
    wsOperator.heartbeatInterval = 3000;
  }, 4000);

  // 发送心跳时触发
  wsOperator.onheartbeat = (params) => {
    console.log("onheartbeat: ", params);
  }

  // 重新连接时触发
  wsOperator.onreconnection = (params) => {
    console.log("onreconnection: ", params);
  }

  // 错误重试达到最大时触发
  wsOperator.onmaxReconnection = (params) => {
    console.log("onmaxReconnection: ", params);
  }

  // 销毁时触发
  wsOperator.ondestroy = (params) => {
    console.log("ondestroy: ", params);
  }

  // 原本 WebSocket 的事件
  wsOperator.onmessage = (params) => {
    console.log("onmessage: ", params);
  }
  wsOperator.onopen = (params) => {
    console.log("onopen: ", params);
  }
  wsOperator.onclose = (params) => {
    console.log("onclose: ", params);
  }
  wsOperator.onerror = (params) => {
    console.log("onerror: ", params);
  }


  // 给服务器发送消息
  // await wsOperator.send("data");

  // 关闭
  // wsOperator.close();

}).catch(err => {
  if (err) {
    alert(err.message);
  }
  console.log("err: ", err);
});
```