DownloadTask

title: DownloadTask

sidebar_label: DownloadTask

一个可以监听下载进度变化事件，以及取消下载任务的对象

支持情况：

参考文档

方法

abort

中断下载任务

支持情况：

参考文档

() => void

onProgressUpdate

监听下载进度变化事件

支持情况：

参考文档

(callback: OnProgressUpdateCallback) => void

offProgressUpdate

取消监听下载进度变化事件

支持情况：

参考文档

(callback: OffProgressUpdateCallback) => void

onHeadersReceived

监听 HTTP Response Header 事件。会比请求完成事件更早

支持情况：

参考文档

(callback: OnHeadersReceivedCallback) => void

offHeadersReceived

取消监听 HTTP Response Header 事件

支持情况：

参考文档

(callback: OffHeadersReceivedCallback) => void

参数

OffHeadersReceivedCallback

HTTP Response Header 事件的回调函数

(res: TaroGeneral.CallbackResult) => void

OffProgressUpdateCallback

下载进度变化事件的回调函数

(res: TaroGeneral.CallbackResult) => void

OnHeadersReceivedCallback

HTTP Response Header 事件的回调函数

(result: OnHeadersReceivedCallbackResult) => void

OnProgressUpdateCallback

下载进度变化事件的回调函数

(result: OnProgressUpdateCallbackResult) => void

OnHeadersReceivedCallbackResult

OnProgressUpdateCallbackResult

DownloadTaskPromise

示例代码

const downloadTask = Taro.downloadFile({
  url: 'http://example.com/audio/123', //仅为示例，并非真实的资源
  success (res) {
    Taro.playVoice({
      filePath: res.tempFilePath
    })
  }
})
downloadTask.onProgressUpdate((res) => {
  console.log('下载进度', res.progress)
  console.log('已经下载的数据长度', res.totalBytesWritten)
  console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
})
downloadTask.abort() // 取消下载任务

API 支持度