Skip to main content

Download

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

// Start the task of waiting for the download before clicking
var waitForDownloadTask = page.WaitForDownloadAsync();
await page.GetByText("Download file").ClickAsync();
var download = await waitForDownloadTask;

// Wait for the download process to complete and save the downloaded file somewhere
await download.SaveAsAsync("/path/to/save/at/" + download.SuggestedFilename);

Methods​

CancelAsync​

Added in: v1.13 download.CancelAsync

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.CancelAsync();

Returns

CreateReadStreamAsync​

Added before v1.9 download.CreateReadStreamAsync

Returns a readable stream for a successful download, or throws for a failed/canceled download.

Usage

await Download.CreateReadStreamAsync();

Returns

  • [Stream]#

DeleteAsync​

Added before v1.9 download.DeleteAsync

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

Usage

await Download.DeleteAsync();

Returns

FailureAsync​

Added before v1.9 download.FailureAsync

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

Usage

await Download.FailureAsync();

Returns

Page​

Added in: v1.12 download.Page

Get the page that the download belongs to.

Usage

Download.Page

Returns

PathAsync​

Added before v1.9 download.PathAsync

Returns 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.SuggestedFilename to get suggested file name.

Usage

await Download.PathAsync();

Returns

SaveAsAsync​

Added before v1.9 download.SaveAsAsync

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.SaveAsAsync("/path/to/save/at/" + download.SuggestedFilename);

Arguments

  • path string#

    Path where the download should be copied.

Returns

SuggestedFilename​

Added before v1.9 download.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 before v1.9 download.Url

Returns downloaded url.

Usage

Download.Url

Returns