@eblib/websocket

eblib 通用 websocket 库

使用

import { EBSocket } from '@eblib/websocket';

type RespContent = {
    // 业务返回的数据结构, 自己定义即可
    userName: string;
    message: string;
};

const ws = new EBSocket<RespContent>(
    url + `?token=${token}`,
    // 业务参数
    {
        bizScene: '业务代码',
        sceneSessionId: '场景会话ID'
    },
    // 配置
    {
        onError(e) {
            console.log(e, '<<<<< error');
        },
        json: true
    }
);

// 监听消息
ws.onMessage(data => {
    console.log(data);
});

// 发送消息
// RespContent 是业务返回的数据结构, 自己定义即可
const sendData: RespContent = {
    userName: '用户名',
    message: 'hello'
};
ws.send(sendData);

API

connect

返回一个 promise, 连接成功后返回 true, 连接失败返回 false 其他所有操作需要等待连接成功后才能进行

send

发送消息, 消息类型为 101

ws.send({
    message: 'hello'
});

onMessage

监听消息, 消息类型为 201

ws.onMessage(data => {
    console.log(data);
});

onPushMessage

监听推送消息, 消息类型为 202

ws.onPushMessage(data => {
    console.log(data);
});

onClosed

监听连接关闭

ws.onClosed(() => {
    console.log('连接关闭');
});

close

主动关闭连接

ws.close();

sendCustom

发送自定义消息, 消息类型为 102

ws.sendCustom(102, {
    message: 'hello'
});