跳转到主要内容

Download

Download 对象由页面通过 page.on('download') 事件分派。

所有属于浏览器上下文的已下载文件在浏览器上下文关闭时会被删除。

下载事件在下载开始时触发。下载路径在下载完成后可用。

// Start waiting for download before clicking. Note no await.
const downloadPromise = page.waitForEvent('download');
await page.getByText('Download file').click();
const download = await downloadPromise;

// Wait for the download process to complete and save the downloaded file somewhere.
await download.saveAs('/path/to/save/at/' + download.suggestedFilename());

方法​

取消​

添加于：v1.13 download.cancel

取消下载。如果下载已完成或已取消，则不会失败。成功取消后，download.failure() 将解析为 'canceled'。

用法

await download.cancel();

返回

createReadStream​

v1.9 之前添加 download.createReadStream

返回成功下载的可读流，如果下载失败/取消，则抛出错误。

用法

await download.createReadStream();

返回

删除​

v1.9 之前添加 download.delete

删除下载的文件。如有必要，将等待下载完成。

用法

await download.delete();

返回

失败​

v1.9 之前添加 download.failure

返回下载错误（如果有）。如有必要，将等待下载完成。

用法

await download.failure();

返回

页面​

添加于：v1.12 download.page

获取下载所属的页面。

用法

download.page();

返回

路径​

v1.9 之前添加 download.path

返回成功下载的下载文件路径，如果下载失败/取消，则抛出错误。如有必要，该方法将等待下载完成。当远程连接时，该方法会抛出错误。

请注意，下载的文件名是随机 GUID，请使用 download.suggestedFilename() 获取建议的文件名。

用法

await download.path();

返回

另存为​

v1.9 之前添加 download.saveAs

将下载内容复制到用户指定的路径。在下载仍在进行时调用此方法是安全的。如有必要，将等待下载完成。

用法

await download.saveAs('/path/to/save/at/' + download.suggestedFilename());

参数

  • path 字符串#

    下载内容应复制到的路径。

返回

建议文件名​

v1.9 之前添加 download.suggestedFilename

返回此下载的建议文件名。它通常由浏览器根据 Content-Disposition 响应头或 download 属性计算得出。请参阅 whatwg 规范。不同的浏览器可能使用不同的逻辑来计算它。

用法

download.suggestedFilename();

返回

网址​

v1.9 之前添加 download.url

返回下载的网址。

用法

download.url();

返回