easy-websocket-c

用于简化websocket操作 npm i easy-websocket-c 基于websocket增加了 心跳重连检测、联网自动重连 功能

一、使用示例

// 简单用法
const a = new EasyWebSocketC();
a.open('ws://localhost:3000/socket').onOpen(() => {
  console.log('opened')
}).onError(err => {
  console.error(err)
}).onClose((event) => {
  console.log('close')
})

// 全配置写法
/**
 * @type { EasyWebSocketCOptions }
 */
const options = {
  /**
   * @type { boolean | AutoContect }
   */
  autoContect: {
    /** 联网重连 - 默认true
      * @description websocket无法稳定检测到网络断开导致的连接关闭，建议保持开启状态。不过即便为关闭状态下，onOffline事件仍会触发
      **/
    onlineContect: true,

    /**
     * 心跳检测最大尝试次数
     * @default 0 永远尝试重新连接
     */
    @JsonProperty()
    max?: number = 0;

    /**
     * 心跳检测(时间ms) 0 为关闭心跳检测, 默认 3 * 1000 ms
     * 即因为意外情况断开时，间隔timeContect时间进行重新连接
     */
    timeContect = 3 * 1000,
  }
}

const easyWebSocketC = new EasyWebSocketC(options);
easyWebSocketC.open('ws://localhost:3000/socket').onOpen(() => {
  console.log('opened')
}).onError(err => {
  console.error(err)
}).onClose((event) => {
  console.log('close')
})

二、Methods

| 方法名 | 说明 | 参数 | 用法示例 | | --- | --- | --- | --- | | open | 创建websocket连接 | url: string \| URL, protocols?: string \| string[], forceOpen?: true | easyWebSocketC.open('ws://localhost:3000/socket') |

| reopen | 重连websocket。直接使用上次open时传入的配置信息重新初始化socket实例 | - | easyWebSocketC.reopen() | | 方法名 | 说明 | 参数 | 用法示例 |

三、生命周期图示