下载

下载

qh.download()

下载文件，调起浏览器下载弹窗。（版本1.4.0开始支持）

qh.download(opts);

参数值：

属性	类型	是否必填	描述
url	string	是	下载资源的 url
fileName	string	否	指定文件保存的文件名，默认为资源的默认文件名
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用完成的回调函数（接口成功、失败都会执行）

success 回调函数：

成功调起下载窗口后，触发回调，无回调参数

qh.downloadFile()

下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。

qh.downloadFile(opts);

参数值：

属性	类型	是否必填	描述
url	string	是	下载资源的 url
header	Object	否	HTTP 请求的 Header，Header 中不能设置 Referer
filePath	string	否	指定文件下载后存储的路径
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用完成的回调函数（接口成功、失败都会执行）

返回值：

Object 类型的对象：

属性	类型	描述
DownloadTask	Object	DownloadTask 实例对象

success 回调函数：

形如 function (res) {…}，其中：

属性	类型	描述
res.tempFilePath	string	临时文件路径。如果没传入 filePath 指定文件存储路径，则下载后的文件会存储到一个临时文件
res.statusCode	number	开发者服务器返回的 HTTP 状态码

DownloadTask

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

DownloadTask.abort

中断下载任务。

DownloadTask.onProgressUpdate

监听下载进度变化事件。

DownloadTask.onProgressUpdate(callback);

DownloadTask.offProgressUpdate

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

DownloadTask.offProgressUpdate();

示例：

const downloadUrl =
  "https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdf_open_parameters.pdf";
const path = "test.pdf";
const task = qh.downloadFile({
  header: {
    "Cache-Control": "no-cache"
  },
  filePath: path,
  url: downloadUrl,
  success: res => console.log("downloadFile数据：", JSON.stringify(res))
});
task.onProgressUpdate(
  ({ progress, totalBytesWritten, totalBytesExpectedToWrite }) => {
    task.abort();
    console.log(
      `downloadFile progress:${progress}%, ${totalBytesWritten}/${totalBytesExpectedToWrite}`
    );
  }
);