# PreDownloadSubpackageTask wx.preDownloadSubpackage(Object object)

基础库 2.27.3 开始支持,低版本需做兼容处理

小程序插件:不支持

# 功能描述

触发分包预下载。

# 参数

# Object object

属性 类型 默认值 必填 说明
packageType string 分包的类型。目前仅支持填 "workers",表示 workers 分包。
success function 分包加载成功回调事件
fail function 分包加载失败回调事件
complete function 分包加载结束回调事件(加载成功、失败都会执行)

# 返回值

# PreDownloadSubpackageTask

预下载分包任务实例,用于获取分包预下载状态

# 注意事项

  • wx.preDownloadSubpackage 目前只开放了下载 worker 分包的能力,还不支持下载普通类型的分包。

# 示例代码

// 首先要在 app.json / game.json 中配置workers作为分包
{
  "workers": {
    "path": "myWorkersFolder",
    "isSubpackage": true  // true 表示把 worker 打包为分包。默认 false。填 false 时等同于 { "workers": "myWorkersFolder" }
  }
}
// 然后调用 wx.preDownloadSubpackage 下载 worker 分包,下载成功后才可以创建 worker
var task = wx.preDownloadSubpackage({
  packageType: "workers",
  success(res) {
    console.log("load worker success", res)
    wx.createWorker("myWorkersFolder/request/index.js")   // 创建 worker。 如果 worker 分包没下载完就调 createWorker 的话将报错
  },
  fail(res) {
    console.log("load worker fail", res)
  }
})

task.onProgressUpdate(res => {
  console.log(res.progress) // 可通过 onProgressUpdate 接口监听下载进度
  console.log(res.totalBytesWritten)
  console.log(res.totalBytesExpectedToWrite)
})