WebSocketAuto

new WebSocketAuto(options)

WebSocket包装,扩展超时、心跳、重连机制

Parameters:
NameTypeDescription
optionsObject

选项配置

Properties
NameTypeAttributesDefaultDescription
urlString

连接地址

protocolsString | Array.<String>

对应的原生WebSocket参数

connectTimeOutNumber<optional>
5000

默认连接超时时间

baseReConnectTimeOutNumber<optional>
2000

重连间隔时间

maxReConnectTimeOutNumber<optional>
60000

重连间隔时间

reConnectRepeatLimitNumber

重连次数限制,不设置则不限制

heartCheckEnableBoolean<optional>
false

默认不开启心跳检测

heartCheckTimeOutNumber<optional>
10000

心跳检测频率

heartCheckPingString | Number<optional>
'ping'

心跳发送包内容

heartCheckPongString | Number<optional>
'pong'

心跳相应包内容

heartCheckCloseTimeOutNumber<optional>
2000

心跳检测超时时间

parseMessageBoolean<optional>
true

开启消息格式化

debugBoolean<optional>
false

开启debug消息打印,需要打开控制台详细级别的输出

Example
import { WebSocketAuto } from '@blinkjun/utils';

const ws = new WebSocketAuto({
 url: 'ws://localhost:8080',
 heartCheckEnable: true,
});

// 发送方法
try{
 ws.send('hello')
}catch(e){

}

// 手动关闭
ws.close()

// 主要监听消息事件
ws.addEventListener('message', (e) => {
 console.log(e);
});

// 连接成功,可省略
ws.addEventListener('open',(e)=>{
 console.log(e)
})

// 连接关闭,可省略
ws.addEventListener('close',(e)=>{
 console.log(e)
})

// 连接错误,可省略
ws.addEventListener('error',(e)=>{
 console.log(e)
})

Extends

  • EventTarget

Methods

close()

手动关闭

send(data)

发送消息

Parameters:
NameTypeDescription
dataObject | String