socket

interface MessageConstructor{
  type:string,      //  "ALL"
  payload?:any,     // 
  id?:string        // idid
}

• API
• Promise

Usage

yarn add @axetroy/wxapp-socket;

const wxSocket = require('@axetroy/wxapp-socket');

new wxSocket({
    url: 'ws://0.0.0.0:10086'
});

wxSocket.on(function(msg) {
  // ...
});

wxSocket.send('hello world')
.then(function(res) {
  // ...
});

API

new wxSocket(config);

• Arguments
  • config

      interface Config {
        url: string;
        data?: any;
        header?: any;
        method?: string;
        retryTimes?: number,        // 
        retryInterval?: number,     // 3s100ms
        success?: () => any;
        fail?: () => any;
        complete?: () => any;
      }
  

wxSocket.on([type:string], callback): () => any[]

• Arguments
  • type?stringtype
  • callback:Function
• Return
  • {Function}

wxSocket.send(msg: any, [config]) : Promise

typetypemessage

• Arguments
  • msg?any
  • config:Object

  interface SendMessageConfig {
    noResponse?: boolean,          // resolve
    timeout?: number               // xxreject
  }
  

• Return
  • {Promise} promise
• Example

  wxSocket.send('hello world');
  /*
    
    {
      "type": "MESSAGE",
      "payload": "hello world",
      "id": "1484540236270908"    // id
    }
  */
  wxSocket.send({type:'LOGIN',payload:{name:"axe",age:100}});
  /*
    
    {
      "type": "LOGIN",
      "payload": {
        name: "axe",
        age: 100
      },
      "id": "1484540236270908"
    }
  */

wxSocket.socketOpen:boolean

socket

wxSocket.messageQueue:array

socketwxSocket.send

socket

License

The MIT License (MIT)

Copyright (c) 2017 axetroy

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.