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:

// Note that Promise.all prevents a race condition
// between clicking and waiting for the download.
const [ download ] = await Promise.all([
  // It is important to call waitForEvent before click to set up waiting.
  page.waitForEvent('download'),
  // Triggers the download.
  page.getByText('Download file').click(),
]);
// wait for download to complete
const path = await download.path();

download.cancel()​

Added in: v1.13

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

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

download.delete()​

Added in: v1.8

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

download.failure()​

Added in: v1.8

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

download.page()​

Added in: v1.12

Get the page that the download belongs to.

download.path()​

Added in: v1.8

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.

download.saveAs(path)​

Added in: v1.8

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.

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.

download.url()​

Added in: v1.8

Returns downloaded url.