---

sidebar_position: 10

Download

Download objects are dispatched by page via the [event: Page.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:

download = page.expect_download do
  page.click('a')
end

# wait for download to complete
path = download.path

> NOTE: Browser context must be created with the acceptDownloads set to true when user needs access to the
downloaded content. If acceptDownloads is not set, download events are emitted, but the actual download is not
performed and user has no access to the downloaded files.

cancel

def cancel

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

delete

def delete

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

failure

def failure

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

page

def page

Get the page that the download belongs to.

path

def 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#suggested_filename to get suggested file
name.

save_as

def save_as(path)

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.

suggested_filename

def suggested_filename

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.

url

def url

Returns downloaded url.