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.
cancelAdded 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
createReadStreamAdded in: v1.8
Returns readable stream for current download or
null if download failed.
deleteAdded in: v1.8
Deletes the downloaded file. Will wait for the download to finish if necessary.
failureAdded in: v1.8
Returns download error if any. Will wait for the download to finish if necessary.
pageAdded in: v1.12
Get the page that the download belongs to.
pathAdded 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.
saveAsAdded 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.
suggestedFilenameAdded 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.
urlAdded in: v1.8
Returns downloaded url.