webscoket-mitt/dist/types/index.d.ts

A plugin library that implements native WebSocket

export type WebSocketMittMessage = {
  id: string,
  event: string,
  data: any,
  timestamp: number
}

export type WebSocketMittMessageType = {
  // 心跳包
  Beat: 'beat',
  // 普通消息
  Message: 'message',
  // 生命周期消息 - 服务连接
  WS_CONNECT: 'ws:connect',
  // 生命周期消息 - 服务错误
  WS_ERROR: 'ws:error',
  // 生命周期消息 - 服务关闭
  WS_CLOSE: 'ws:close',
  // 生命周期消息 - 服务退出
  WS_EXIT: 'ws:exit',
  // 生命周期消息 - 重连
  WS_RECONNECT: 'ws:reconnect',
  // 生命周期消息 - 重连失败
  WS_RECONNECT_FAILED: 'ws:reconnect-failed',
  // 生命周期消息 - 重连成功
  WS_RECONNECT_SUCCESS: 'ws:reconnect-success',
  // 生命周期消息 - 心跳响应失败
  WS_HEARBEAT_FAILED: 'ws:heartbeat-failed'
}

export type WebSocketMittOptions = {
  url: string,
  heartbeatInterval: number,
  heartbeatMaxMissCount: number,
  reconnectDelay: number,
  maxReconnectDelay: number,
  maxReconnectCount: number,
  logging: boolean
}

export declare class WebSocketMitt {
  // 消息事件类型
  static MessageType: WebSocketMittMessageType

  // 构造函数
  constructor(options: WebSocketMittOptions)

  // 方法 - 设置配置
  setOptions(options: WebSocketMittOptions) : void

  // 方法 - 连接服务
  connect(): void

  // 方法 - 关闭服务
  exit(): void

  // 方法 - 消息接收
  $on(event: string, callback: (message: WebSocketMittMessage) => void): void

  // 方法 - 发送消息
  $emit(event: string, message: any): void
}