Skip to content
v1
文档/Browser JS SDK/开发指南

@beeworks/imsdk


@beeworks/imsdk

@beeworks/imsdk: IM JS-SDK

Development

  • lint: 代码检查及自动格式化
bash
npm run lint
  • build: 构建
bash
npm run build
  • docs: 文档

基于 TypeDoc 生成文档,配合 Vitepress 主题插件,提供在线文档预览。

bash
# 生成文档
npm run docs

# 调试文档,调整注释后需重新运行
npm run docs:dev

调试

  • demo: 运行 Demo 项目,用于本地调试。

进入 demo 文件夹,本地启动 server 服务,用于调试。JWT 可以通过下面脚本方式获取:

bash
# 进入目录
cd scripts

# 运行脚本
node scripts/generate-jwt.js [userId] [name]

# 完成后,JWT Token 会自动复制到粘贴板
  • jwt-server: 运行 JWT 服务,用于生成 JWT Token。
bash
# 直接在根目录运行
npm run demo:jwt-server

Release

  • release: 发布 NPM 包。需要账号权限,发布前先确保 lint 及 build 已通过。
bash
npm run release

Jitsi 适配器是独立的 NPM 包,使用独立版本号和 tag 发布:

bash
npm run release:jitsi-adapter -- 0.1.1

该命令会构建并执行 adapter smoke test,然后发布 @beeworks/imsdk-jitsi-adapter;对应的 Git tag 格式为 jitsi-adapter-v<version>