# wx.downloadFile


小程序框架2.0.5版本开始支持

下载文件功能,调用该方法返回一个downloadTask实例。

# 参数

# Object object

属性 类型 默认值 必填 说明
url string 上传服务器地址
timeout number 超时时间,单位为毫秒,错误入参将忽略默认为3000ms
success function 接口调用成功的回调函数(服务器返回状态码403、404之类的也是走成功回调)
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

# object.success 回调函数

# 参数

Object res

属性 类型 说明
tempFilePath string 临时文件地址(lightresource协议)
header Object 响应头
statusCode number 服务器响应状态码(200是成功)

# 示例代码

let task = wx.downloadFile({
  url: "https://img0.baidu.com/it/u=3101694723,748884042&fm=26&fmt=auto&gp=0.jpg",
  timeout: 5000,
  success:data =>{
    console.log(JSON.stringify(data))
  }
})
task.onProgressUpdate(data =>{
  console.log(JSON.stringify(data))
})
task.onHeadersReceived(data =>{
  console.log(JSON.stringify(data))
})

# 实例的方法

# void downloadTask.onProgressUpdate(function cb)

监听下载进度事件,会多次触发,在任务结束回调之前触发。

# 参数

属性 类型 默认值 必填 说明
cb function 对应的回调函数
# 回调参数

Object res

属性 类型 说明
progress number 下载进度百分比
totalBytesWritten number 已下载字节数
totalBytesExpectedToWrite number 总字节数

# void downloadTask.onHeadersReceived(function cb)

监听HTTP Response Header 事件,在任务结束回调之前触发。

# 参数

属性 类型 默认值 必填 说明
cb function 对应的回调函数
# 回调参数

Object res

属性 类型 说明
header Object 响应头

# void downloadTask.offProgressUpdate(function cb)

取消监听下载进度事件

# 参数

属性 类型 默认值 必填 说明
cb function 对应的回调函数

# void downloadTask.offHeadersReceived(function cb)

取消监听HTTP Response Header 事件

# 参数

属性 类型 默认值 必填 说明
cb function 对应的回调函数

# void downloadTask.abort()

取消下载任务