playwright/docs/src/downloads.md

id	title
downloads	Downloads

:::note For uploading files, see the uploading files section. :::

For every attachment downloaded by the page, [event: Page.download] event is emitted. All these attachments are going to be downloaded into a temporary folder. You can obtain the download url, file system path and payload stream using the [Download] object from the event.

You can specify where to persist downloaded files using the [option: downloadsPath] option in [method: BrowserType.launch].

:::note Downloaded files are deleted when the browser context that produced them is closed. :::

Here is the simplest way to handle the file download:

const [ download ] = await Promise.all([
  // Start waiting for the download
  page.waitForEvent('download'),
  // Perform the action that initiates download
  page.locator('button#delayed-download').click(),
]);
// Wait for the download process to complete
const path = await download.path();

// Wait for the download to start
Download download = page.waitForDownload(() -> {
    // Perform the action that initiates download
    page.click("button#delayed-download");
});
// Wait for the download process to complete
Path path = download.path();

# Start waiting for the download
async with page.expect_download() as download_info:
    # Perform the action that initiates download
    await page.click("button#delayed-download")
download = await download_info.value
# Wait for the download process to complete
path = await download.path()

# Start waiting for the download
with page.expect_download() as download_info:
    # Perform the action that initiates download
    page.click("button#delayed-download")
download = download_info.value
# Wait for the download process to complete
path = download.path()

// Start the task of waiting for the download
var waitForDownloadTask = page.WaitForDownloadAsync();
// Perform the action that initiates download
await page.ClickAsync("#downloadButton");
// Wait for the download process to complete
var download = await waitForDownloadTask;
var path = await download.PathAsync();

Variations

If you have no idea what initiates the download, you can still handle the event:

page.on('download', download => download.path().then(console.log));

page.onDownload(download -> System.out.println(download.path()));

async def handle_download(download):
    print(await download.path())
page.on("download", handle_download)

page.on("download", lambda download: print(download.path()))

page.Download += (sender, download) => Console.WriteLine(download.Url);

Note that handling the event forks the control flow and makes script harder to follow. Your scenario might end while you are downloading a file since your main control flow is not awaiting for this operation to resolve.

API reference

• [Download]
• [event: Page.download]