https://github.com/weapp-socketio/weapp.socket.io

A WebSocket client for building WeChat Mini Program implement by socket.io
https://github.com/weapp-socketio/weapp.socket.io

chameleon kbone mpvue socket tarojs websocket-client wechat-mini wepy

Last synced: 2 months ago
JSON representation

A WebSocket client for building WeChat Mini Program implement by socket.io

• Host: GitHub
• URL: https://github.com/weapp-socketio/weapp.socket.io
• Owner: weapp-socketio
• License: mit
• Created: 2018-04-16T02:23:08.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-18T02:40:45.000Z (about 1 year ago)
• Last Synced: 2024-03-11T13:06:41.043Z (2 months ago)
• Topics: chameleon, kbone, mpvue, socket, tarojs, websocket-client, wechat-mini, wepy
• Language: JavaScript
• Homepage: http://weappsocket.matong.io
• Size: 1.04 MB
• Stars: 674
• Watchers: 20
• Forks: 170
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• awesome-wechat-weapp - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-weapp - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-app - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-weapp - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-weapp - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-weapp - weapp.socket.io - socket.io 风格的 websocket 类库 (组件)
• awesome-wechat-weapp - weapp.socket.io ★500+ - socket.io 风格的 websocket 类库 (组件)

README

        


  





  A WebSocket client for building WeChat Mini Program implement by socket.io





  

    

  

  

    

    

  

  

    

    

  

  

    

  

  

    

  



## Feature

Full feature socket.io style implemented, based-on `[email protected]` version, such as:

- send message queue

- auto reconnect

- ping, pong

- room, namespaces

## Platform Support

  - 微信

  - 支付宝

## Demos

[Official Framework](https://github.com/wxsocketio/socket.io-weapp-demo) , [Wepy Framework](https://github.com/weapp-socketio/wepy-demo-socket.io)

## Install

If you use a third-party framework such as [wepy](https://github.com/Tencent/wepy), you should install via `npm`

```

$ npm install weapp.socket.io

```

Or if you use the native way to write code，I recommend using `git clone`

```

$ git clone https://github.com/weapp-socketio/weapp.socket.io

# development mode

$ npm run build-dev

# production mode

$ npm run build

$ cp path/weapp.socket.io/dist/weapp.socket.io.js path/your_weapp_dir

```

## Usage

code style is same to [socket.io-client](https://github.com/socketio/socket.io-client)

```

const io = require('./yout_path/weapp.socket.io.js')

const socket = io('https://socket-io-chat.now.sh')

socket.on('connect', () => {

  console.log('connection created.')

});

socket.on('new message', d => {

  const {

    username,

    message

  } = d;

  console.log('received: ', username, message)

});

socket.emit('add user', "Jack");

```

## API

See [socket.io-client API](https://github.com/socketio/socket.io-client/blob/master/docs/API.md)

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](.github/CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/weappsocketio/contribute)]