跳到正文
本页尚未翻译成中文,以下为英文原文。 查看英文版

Download ​

Added in: v1.8

Download objects are dispatched by page via the page.on('download') event.

All the downloaded files belonging to the browser context are deleted when the browser context is closed.

Download event is emitted once the download starts. Download path becomes available once download completes.

js
// 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());

Methods ​

download.cancel() ​

Added in: v1.13 async

Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure() would resolve to 'canceled'.

download.createReadStream() ​

Added in: v1.8 async

Returns a readable stream for a successful download, or throws for a failed/canceled download.

INFO

If you don't need a readable stream, it's usually simpler to read the file from disk after the download completed. See download.path().

Returns

  • Promise<Readable>

download.delete() ​

Added in: v1.8 async

Deletes the downloaded file. Will wait for the download to finish if necessary.

download.failure() ​

Added in: v1.8 async

Returns download error if any. Will wait for the download to finish if necessary.

Returns

  • Promise<null | string>

download.page() ​

Added in: v1.12

Get the page that the download belongs to.

Returns

  • Page

download.path() ​

Added in: v1.8 async

Returns path to the downloaded file for a successful download, or throws for a failed/canceled download. The method will wait for the download to finish if necessary. The method throws when connected remotely.

Note that the download's file name is a random GUID, use download.suggestedFilename() to get suggested file name.

Returns

  • Promise<path>

download.saveAs() ​

Added in: v1.8 async

Copy the download to a user-specified path. It is safe to call this method while the download is still in progress. Will wait for the download to finish if necessary.

Usage

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

Arguments

  • path path

    Path where the download should be copied.

download.suggestedFilename() ​

Added in: v1.8

Returns suggested filename for this download. It is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on whatwg. Different browsers can use different logic for computing it.

Returns

  • string

download.url() ​

Added in: v1.8

Returns downloaded url.

Returns

  • string

基于 Apache 2.0 许可证发布。