Skip to main content

Download

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:

// 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.
console.log(await download.path());

Methods​

cancel​

Added in: v1.13download.cancel

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

Usage

await download.cancel();

createReadStream​

Added in: v1.8download.createReadStream

Returns readable stream for current download or null if download failed.

Usage

await download.createReadStream();

Returns

delete​

Added in: v1.8download.delete

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

Usage

await download.delete();

failure​

Added in: v1.8download.failure

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

Usage

await download.failure();

Returns

page​

Added in: v1.12download.page

Get the page that the download belongs to.

Usage

download.page();

Returns

path​

Added in: v1.8download.path

Returns path to the downloaded file in case of successful 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.

Usage

await download.path();

Returns

saveAs​

Added in: v1.8download.saveAs

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

await download.saveAs(path);

Arguments

  • path string#

    Path where the download should be copied.

suggestedFilename​

Added in: v1.8download.suggestedFilename

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.

Usage

download.suggestedFilename();

Returns

url​

Added in: v1.8download.url

Returns downloaded url.

Usage

download.url();

Returns