1.0.2 • Published 4 years ago

websocket-events-js v1.0.2

Weekly downloads
1
License
ISC
Repository
-
Last release
4 years ago

这个包 基于websocket-heatbeat-js 封装,所以参数支持所以 websocket-heatbeat-js 参数

另外新增了一个参数 messageHandler 这是一个函数 是用来处理socket消息的

由于处理相应是基于事件的 所以 需要通过 messageHandler 这个函数作为一个 处理消息的规则

必须返回 {type, data}

  • type 用于作为事件的名称 即触发时的key
  • data 作为事件的参数

实例方法

  • on 用于监听事件 参数为 事件名称及回调
  import Websocketjs from 'websocket-event-js';
  let opts = {
      url: 'http://xxx',
      // 接受socket的 推送值作为参数
      messageHander: function(res) => {
          let type = res.desc;
          let data = res.value;
          return {type, data}
      }
  }
  let websocketjs = new Websocketjs(opts);
  // 当消息到来且 类型为type1 时 会触发
  websocketjs.on('type1', function() {
      // ...todo
  })
  // 如果消息的类型 没有被监听 则会触发 默认default 事件
  websocketjs.on('default', function() {
      // 这里接受 所以没有被监听的事件
      // ...todo
  })
  • unbind 用于取消监听事件 参数为事件名称
  import Websocketjs from 'websocket-event-js';
  let opts = {
      url: 'http://xxx',
      // 接受socket的 推送值作为参数
      messageHander: function(res) => {
          let type = res.desc;
          let data = res.value;
          return {type, data}
      }
  }
  let websocketjs = new Websocketjs(opts);
  // 当消息到来且 类型为type1 时 会触发
  websocketjs.on('type1', function() {
      // ...todo
  })
  websocketjs.unbind('type1');
  // 如果消息的类型 没有被监听 则会触发 默认default 事件
  websocketjs.on('default', function() {
      // 由于type1 事件被销毁 所以会触发default
      // ...todo
  })