caihc001 / weapp.socket.io

socket.io client for Wechat mini program

weapp.socket.io is a client live in Wechat mini program environment based-on socket.io and full features to socket.io-client a browser version.

Feature

Full feature socket.io style implemented, based-on socket.io@2.0 version

NOTE: Only support websocket transport, removed polling transport.

Demos

Weapp Demo

Wepy Demo

Install

If you use a third-party framework such as wepy, you should install via npm

  npm i weapp.socket.io

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

  git clone https://github.com/10cella/weapp.socket.io

  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

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

const socket = io('http://localhost:8000')

socket.on('news', d => {
  console.log('received news: ', d)
})

socket.emit('news', { title: 'this is a news' })

API

See socket.io-client API

TODO

• AliPay mini program support

Contributing

用户信息征集

如果你的项目正在使用 weapp.socket.io 欢迎留下你的项目信息（名称，Logo，官网等）

可以在 这个 Issue 提交您的项目信息