js-homos
v0.2.3
Published
SDK of HomOS
Downloads
47
Readme
Intro
基于 father 及 wx 小程序接口搭建
┏━━━━━━━━━━ js-homos ━━━━━━━━━━━━━┓
┃ ┃
┃ ┌─── WechatMiniprogram.Wx ──────┐ ┃
┃ │ wx.request │ wx.connectSocket │ ┃
┃ └────────────┴──────────────────┘ ┃
┃ ┌─── cloud ───┐ ┃
┃ │ meizgd.com │ ┃
┃ └─────────────┘ ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
在项目使用
pnpm add js-homos
执行 构建npm
后即可引用:
// ~/package-mine/device-replace/index.ts
import { deviceReplace } from 'js-homos'
const res = await deviceReplace({
newDevId,
oldDevId,
}, { loading: true })
console.log('deviceReplace', res.result)
如下动图,支持接口 payload、参数、返回数据的类型自动提示:
开发&调试
$ pnpm i # 安装开发依赖
$ pnpm add yalc -g # 全局安装yalc,本地调试可代替 `npm link`
$ pnpm dev # 运行项目
$ yalc publish # 发布到本地仓库
$ yalc push # 手动同步,本地发布到关联项目
$ yalc link js-homos # 在要关联的项目下执行
# 在sdk项目下执行即可
$ pnpm build:push # 构建的同时,本地发布到关联项目
$ yalc remove all # 清除项目关联
关联项目中,忽略文件增加:
# ~/.gitignore
yalc.lock
.yalc
构建&发布
$ pnpm build # 构建
$ npm version major # 更新主版本号(major),做了不兼容的API修改
$ npm version minor # 更新次版本号(minor),做了向下兼容的功能性新增
$ npm version patch # 修订号(patch),做了向下兼容的问题修正
$ npm publish # 自动重新构建并发布
$ pnpm add js-homos@latest # 项目端执行,更新到最新版本
代码结构
js-homos
├── docs // 接口文档
├── src // 源代码目录
│ ├── apis // 接口定义
│ ├── config // 项目配置
│ ├── request // 请求方法定义
│ ├── types // 类型定义
│ ├── utils // 工具方法定义
│ └── index.ts // 入口文件
└── .fatherrc.ts // SDK 框架参数定义