1.1.0 • Published 3 years ago
node-js-easysocket v1.1.0
socket 基本用法
即时通讯二次封装
Installation
$ npm install node-js-easysocket
API
import socket from 'node-js-easysocket'
let socket=require('node-js-easysocket').default
'默认采用es6引入'
var socket=new socket({url:'地址',heartBeat:5000,heartMsg:{'参数'},reconnect:true,reconnectTime:5000,reconnectTimes:2})
socket.onopen(e=>{
console.log(e,'socket实例')
})
socket.send({'数据'})
socket.onmessage(e=>{
console.log(e,'服务器返回数据')
})
socket.onreconnect(e=>{
console.log(e,'socket实例(可根据readystate值来进行业务处理 0,1,2,3)')
})
socket.onclose(e=>{
console.log(e,'socket实例')
})
socket.onerror(e=>{
console.log(e,'socket实例(因初始化只调用一次,一般在onreconnect处理)')
})
Attributes
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
url | 协议连接(ws) | String | — | - |
heartBeat | 心跳时间 | Number | — | 5000ms |
heartMsg | 心跳包 | Object | — | {} |
reconnect | 是否重连 | Boolean | — | true |
reconnectTime | 重连间隔时间 | Number | — | 5000ms |
reconnectTimes | 重连次数 | Number | — | 2 |
Events
事件名称 | 说明 | 回调参数 |
---|---|---|
onopen | 连接成功回掉 | event |
send | 数据发送 JSON | event |
onmessage | 发送信息回掉 | data回掉数据 |
onreconnect | 重连回掉 (处理防御处理逻辑) | event |
onclose | 关闭回掉 | event |
onerror | 错误回掉 | event |