1.0.1 • Published 3 years ago
better-web-socket v1.0.1
插件名称
更好用的 WebSocket
安装
项目采取 UMD 的形式打包
npm i --save better-web-socket
使用
/**
* class BetterWebSocket
* @param { String } url - 接口地址
* @param { Object } [opts] - 其他配置
* @param { Boolean | Function } [opts.retry=false] - 是否断开重连,Function 需要返回 Boolean,可以返回 Promise
* @param { Number } [opts.retryDelay=1000] - 重连的延迟时间
**/
import BetterWebSocket from 'better-web-socket'
let bws = new BetterWebSocket('ws:xxxxxxx', {
retry () {
/* 代表是否可以重连 */
/* 可以返回 Promise,结果为 Boolean 类型即可*/
/* 默认值为 false */
},
/* 重连的延迟时间 */
retryDelay: 1000
})
// 事件绑定(open、message、error、close)
// bws.on(eventName, handler)
// bws.once(eventName, handler)
// bws.off(eventName, handler)
// 发送消息(原生 send 方法)
// bws.send()
// 关闭连接(原生 close 方法)
// bws.close()