1.0.13 • Published 1 year ago
update-app-server v1.0.13
APP更新服务端库
基本介绍。
本库是一个APP更新服务端库,提供了基本的下载和上传功能,可以根据业务实现回调函数,实现自定义的业务逻辑。 JSON 模式暂不支持回滚功能,如果需要回滚功能请使用数据库模式。
安装方法。
npm install update-app-server
使用方式介绍
开始使用
- 创建一个类作为APP更新的工具类
- 导入UpdateApp类并继承
- 根据业务实现回调函数
导入UpdateApp.
// 导入一个基础类
import { UpdateApp , JsonFileStorage } from "update-app-server"
继承并实现回调函数.
注意事项:
1. 需要将数据源传递到父类构造 Super
1. 在调用Start 或者 Upload 方法的时候可以传一个dist对象 该对象会覆盖整个流程
import { UpdateApp , JsonFileStorage, Tools} from "update-app-server"
export class UpdateService extends UpdateApp{
constructor() {
// 初始化数据源并传递到父类
// 目前只实现了JsonFile 使用Json和文件作为存储的数据源
let jsonFile = "../package/version.json";
let packPath = "../package/packs";
let jsonFileStorage = new JsonFileStorage(join(__dirname,jsonFile) ,join(__dirname,packPath))
super(jsonFileStorage)
}
/**
* 下载开始前回调
* @param version 最新版本号
* @param next 同意下载
* @param refuse 拒绝下载
*/
BeginDownload(version: string, next: (version: string) => void, refuse: ()=>void, dist: any):void {
console.log("下载回调");
}
/**
* 上传开始回调
* @param version 上传的版本号
* @param next 同意上传
* @param refuse 拒绝上传
*/
BegineUpload(version: string, next: (version: string) => void, refuse: Function, dist: any): void {
console.log("上传回调");
}
/**
* 下载结束回调
* @param file 如果 Start 第一个参数为 true 返回二进制流 如果为 false 返回文件地址
*/
AfterDownload(file: string | Buffer,dist):void {
console.log("下载完成")
}
RefuseDownload(version: string,dist):void {
console.log("下载失败-拒绝下载")
}
AfterUpload(version: string,dist):void {
console.log("上传完成")
}
RefuseUpload(dist): void {
console.log("上传失败-拒绝上传")
}
}