Download
Added in: v1.8Download 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 the download
async with page.expect_download() as download_info:
# Perform the action that initiates download
await page.get_by_text("Download file").click()
download = await download_info.value
# Wait for the download process to complete and save the downloaded file somewhere
await download.save_as("/path/to/save/at/" + download.suggested_filename)# Start waiting for the download
with page.expect_download() as download_info:
# Perform the action that initiates download
page.get_by_text("Download file").click()
download = download_info.value
# Wait for the download process to complete and save the downloaded file somewhere
download.save_as("/path/to/save/at/" + download.suggested_filename)Methods
download.cancel()
Added in: v1.13Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure() would resolve to 'canceled'.
download.delete()
Added in: v1.8Deletes the downloaded file. Will wait for the download to finish if necessary.
download.failure()
Added in: v1.8Returns download error if any. Will wait for the download to finish if necessary.
Returns
null | string
download.page()
Added in: v1.12Get the page that the download belongs to.
Returns
Page
download.path()
Added in: v1.8Returns 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.suggested_filename() to get suggested file name.
Returns
path
download.save_as()
Added in: v1.8Copy 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.save_as("/path/to/save/at/" + download.suggested_filename)download.save_as("/path/to/save/at/" + download.suggested_filename)Arguments
download.suggested_filename()
Added in: v1.8Returns 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.8Returns downloaded url.
Returns
string