class: 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. All downloaded files are deleted when the browser closes.

Download event is emitted once the download starts. Download path becomes available once download completes:

const [ download ] = await Promise.all([
  page.waitForEvent('download'), // wait for download to start
  page.click('a')
]);
// wait for download to complete
const path = await 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 or set to false, download events are emitted, but the actual download is not performed and user has no access to the downloaded files.

async method: Download.createReadStream

langs: js

returns: <[null]|[Readable]>

Returns readable stream for current download or null if download failed.

async method: Download.delete

Deletes the downloaded file.

async method: Download.failure

returns: <[null]|[string]>

Returns download error if any.

async method: Download.path

returns: <[null]|[string]>

Returns path to the downloaded file in case of successful download.

async method: Download.saveAs

Saves the download to a user-specified path.

param: Download.saveAs.path

path <[path]>

Path where the download should be saved.

method: Download.suggestedFilename

returns: <[string]>

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.

method: Download.url

returns: <[string]>

Returns downloaded url.

2 KiB Raw Blame History