0.0.2 • Published 2 years ago

popmart-web-ws-sdk v0.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

web端使用的weksocket

参数

参数名类型说明必填
urlstring服务器接口地址
maxnumber连接失败时最大重连次数,默认不重连
delaynumber连接失败时下一次重连间隔时长(秒) 默认15s
midstring鉴权id
roomIdstring鉴权roomid
heartBeatnumber长链接心跳间隔(秒),默认60s

方法

方法名类型说明备注
connectSocketFunction创建websocket连接返回 Promise
closeSocketFunction关闭websocket连接返回 Promise
sendSocketMessageFunction向服务端发送消息返回 Promise
receiveSocketMessageFunction接受来自服务端消息传入一个callback参数

uniapp项目中使用

  • 创建PmWsSdk实例
      import PmWsSdk from 'popmart-uni-ws-sdk'
      const ws = new PmWsSdk({url, max: 3, delay: 2000, mid: '123'})
  • connectSocket - 创建websocket连接 (下例是采用async await方式)
      async create () {
        await ws.connectSocket()
      }
  • sendSocketMessage - 向服务端发送消息(时序在创建之后)
        ws.sendSocketMessage({a: 111, g: 'zdbhjadsjhg'}).then(res => {
    						console.log('success =====> 消息发送成功!')
    					}).catch(err =>{
    						console.log('fail =====> 消息发送失败!')
    					})
  • receiveSocketMessage - 接受来自服务端消息(注意callback中event类型)
      ws.receiveSocketMessage((res) => {
        const {event} = res
        switch (event) {
          case 'heartBeat':
            console.log('长链接心跳')
            break;
          case 'messageReceived':
            console.log('接收到服务端推送消息')
            break;
        }
      })
  • closeSocket - 关闭websocket连接
      ws.closeSocket().then(() => {
    						console.log('关闭成功!!!!!')
    					})

有问题反馈

在使用中有任何问题,欢迎反馈给我,可以用以下联系方式跟我交流

  • POPMART飞书中查找==> 李辰晗(前端开发)
0.0.2

2 years ago

0.0.1

2 years ago