im-sdk-ts v0.1.46

IM sdk （有消息前端IM部分SDK）

主要功能

• 连接远程 websocket 服务器并监听
• 用户连接成功/失败的回调
• 发送/接收消息
• 开启或关闭日志
• 主动断开连接(不重连)
• 连接断开或错误 自动重连
  • 重连最多 3 次 重连间隔 3s
  • 重连成功/失败的回调
• 也可手动重连
• 与服务器端的心跳保持 间隔 1 分钟
• 账号在其他地方登录（如 APP）的回调
• 网络变化（如断线、重新连接）的回调
• 发送/接收消息时的类型定义常量

本地环境

• node版本建议大于10.0
• typescript版本建议大于3.7

注：编辑器需要安装eslint、prettier等常用格式化工具

命令

• 本地开发 npm start
• 打包 npm run build

Usage 使用

import { imConnect, imEventInstance, WebsocketEvent } from 'im-sdk-ts';

// 获取IM实例
const im = imConnect(url, {loginUserId: 'xx', loginToken: 'xx'});
// 获取IM事件订阅器实例
const imEvent = imEventInstance();
im.setDebugEnable(true);
im.setDebugPingPongEnable(false);

imEvent.socketOn(WebsocketEvent.EVENT_LOG, content => {
  console.log(content);
});
imEvent.socketOn(WebsocketEvent.EVENT_RECONNECT_SUCCESS, () => {
  console.log('掉线重连成功了');
});

// 建立连接
im.connectAndListen()
// 发送单聊
im.send121Msg(msg)
// 断开连接
im.disconnect()

Example

详细例子见：examples/src/pages/index.tsx

onIMData 消息回调的详细文档 见消息文档

ImSdk实例方法

发布

执行npm publish

参考

脚手架

• https://github.com/jaredpalmer/tsdx
• https://github.com/jsynowiec/node-typescript-boilerplate

feature

• Package webSocket and define Porotocal that equal server side
• Written in TypeScript with predictable static types.
• Provide some function change environment variable for debug,etc: setDebugEnable(),setDebugPingPongEnable().
• Use JEST for unit testing