Skip to content

weapp-socketio/weapp.socket.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

af2fba0 · Nov 19, 2022

History

62 Commits
Oct 29, 2020
Dec 6, 2021
Sep 1, 2021
Aug 23, 2019
Apr 29, 2020
Sep 1, 2021
Jun 20, 2018
Nov 19, 2022
Oct 29, 2020
Nov 19, 2022
Nov 19, 2022
Nov 19, 2022
Mar 14, 2022

Repository files navigation

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

Feature

Full feature socket.io style implemented, based-on socket.io@3.x version, such as:

  • send message queue
  • auto reconnect
  • ping, pong
  • room, namespaces

Platform Support

  • 微信
  • 支付宝

Demos

Official Framework , Wepy Framework

Install

If you use a third-party framework such as 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

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

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]