Interface Download

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 and save the downloaded file somewhere.
await download.saveAs('/path/to/save/at/' + download.suggestedFilename());

Hierarchy

  • Download

Methods

cancel createReadStream delete failure page path saveAs suggestedFilename url

Methods

cancel

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

    Returns Promise<void>

createReadStream

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

    Returns Promise<Readable>

delete

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

    Returns Promise<void>

failure

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

    Returns Promise<string>

page

  • Get the page that the download belongs to.

    Returns Page

path

  • 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.

    Returns Promise<string>

saveAs

  • 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.saveAs('/path/to/save/at/' + download.suggestedFilename());

    Parameters

    • path: string

      Path where the download should be copied.

    Returns Promise<void>

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.

    Returns string

url

  • Returns downloaded url.

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc