ql-message

ql-message

a websocket client

安装

// with npm
npm install ql-message

// with yarn
yarn add ql-message

使用

引入

import QlMessage from 'ql-message';

初始化

//建议全局维护一个 `QlMessage`
const qlmessage = QlMessage.getInstance({ appId: 'xxx', appkey: 'xxx', host: 'localhost', autoReconnect: true });

连接

//连接
qlmessage.connect({
	onSuccess: function (data) {
		//连接成功
	},
	onFailed: function (data) {
		//连接失败
	}
});

//断开连接
qlmessage.disconnect();

订阅

//订阅
qlmessage.subscribe({
	//替换为您自己的channel
	channel: 'my_channel',
	//频道消息
	onMessage: function (message) {
		console.log('Channel:' + message);
	},
	//订阅频道成功
	onSuccess: function () {
		console.log('Channel订阅成功。');
	},
	//订阅频道失败
	onFailed: function (error) {
		console.log('Channel订阅失败, 错误' + error);
	}
});
//取消订阅
qlmessage.unsubscribe({
	channel: 'my_channel',
	onSuccess: function () {
		alert('订阅取消成功。');
	},
	onFailed: function (error) {
		alert('取消订阅失败，错误：' + error);
	}
});
//或者
qlmessage.unsubscribe('my_channel');