playwright/docs/src/api/class-download.md

82 lines
2.4 KiB
Markdown
Raw Normal View History

# 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:
```js
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();
```
```python async
async with page.expect_download() as download_info:
await page.click("a")
download = await download_info.value
# waits for download to complete
path = await download.path()
```
```python sync
with page.expect_download() as download_info:
page.click("a")
download = download_info.value
# wait for download to complete
path = download.path()
```
2021-01-12 12:14:27 -08:00
:::note
Browser context **must** be created with the [`option: acceptDownloads`] set to `true` when user needs access to the
downloaded content. If [`option: acceptDownloads`] is not set, download events are emitted, but the actual download is
not performed and user has no access to the downloaded files.
2021-01-12 12:14:27 -08:00
:::
## async method: Download.createReadStream
* langs: java, 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
2021-01-12 12:14:27 -08:00
- returns: <[null]|[path]>
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`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header
or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources). Different
browsers can use different logic for computing it.
## method: Download.url
- returns: <[string]>
Returns downloaded url.