1.0.0 • Published 3 years ago

yim-wxmini-sdk v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

yim-wxmini-sdk

yim-wxmin-sdk(yideb im wechat miniprogram sdk)是IM消息针对微信小程序的js开发工具包,基于websocket与im服务器连接,用于im消息相关功能。

说明

im消息可能会在多个项目使用,在与im服务端交互的逻辑上,各个前端项目基本是一致的,为了统一管理和升级,避免人工手动拷贝的方式传递代码,不便于以后版本升级,bug修复等,因此,这部分代码形成sdk库,作为以后im的基础环境库,形成明医众禾的前端im库的实现之一。

安装

本地调试安装

本地调试安装是直接将该sdk源码映射到使用项目当中,以后调试过程中同时调试sdk的代码逻辑。

git clone https://git.ylk360.com/hospital/yideb-im-sdk-dev.git

cd yideb-im-sdk-dev/yim-wxmini-sdk

# 创建npm本地link全局映射
npm link

# 微信小程序现在已支持npm安装第三方库,具体参见[npm支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html)
# 进入微信小程序项目目录,执行链接
npm link yim-wxmini-sdk

发布安装

发布安装是指sdk稳定后,作为npm可用的库发布在npm.js开发库里(注意:发布的是编译压缩后的代码),使用项目使用npm install的方式安装在项目中使用。

# 进入使用sdk的项目目录,执行链接
npm install --save yim-wxmini-sdk

接口

yim-wxmini-sdk库向外导出了yim对象。yim包含了整个im交互的所有接口。具体参见源码: yim