Download
Download オブジェクトは、page.on('download') イベントを介してページによってディスパッチされます。
ブラウザコンテキストに属するすべてのダウンロードファイルは、ブラウザコンテキストが閉じられると削除されます。
ダウンロードイベントは、ダウンロードが開始されるとすぐに発行されます。ダウンロードパスは、ダウンロードが完了すると利用可能になります。
// 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());
メソッド
cancel
追加バージョン: v1.13ダウンロードをキャンセルします。ダウンロードがすでに完了またはキャンセルされている場合でも失敗しません。正常にキャンセルされると、download.failure() は 'canceled' に解決されます。
使用例
await download.cancel();
戻り値
createReadStream
v1.9 より前に追加成功したダウンロードのために Readable Stream を返します。失敗/キャンセルされたダウンロードの場合は例外をスローします。
使用例
await download.createReadStream();
戻り値
delete
v1.9 より前に追加ダウンロードしたファイルを削除します。必要に応じてダウンロードが完了するまで待機します。
使用例
await download.delete();
戻り値
failure
v1.9 より前に追加ダウンロードエラーがあれば返します。必要に応じてダウンロードが完了するまで待機します。
使用例
await download.failure();
戻り値
page
追加バージョン: v1.12ダウンロードが属するページを取得します。
使用例
download.page();
戻り値
path
v1.9 より前に追加成功したダウンロードの場合、ダウンロードしたファイルへのパスを返します。失敗/キャンセルされたダウンロードの場合は例外をスローします。このメソッドは、必要に応じてダウンロードが完了するまで待機します。リモート接続時には例外をスローします。
ダウンロードのファイル名はランダムな GUID であることに注意してください。推奨されるファイル名を取得するには、download.suggestedFilename() を使用してください。
使用例
await download.path();
戻り値
saveAs
v1.9 より前に追加ダウンロードをユーザー指定のパスにコピーします。ダウンロードがまだ進行中でも、このメソッドを安全に呼び出すことができます。必要に応じてダウンロードが完了するまで待機します。
使用例
await download.saveAs('/path/to/save/at/' + download.suggestedFilename());
引数
戻り値
suggestedFilename
v1.9 より前に追加このダウンロードの推奨ファイル名を返します。通常、ブラウザによって Content-Disposition レスポンスヘッダーまたは download 属性から計算されます。whatwg の仕様を参照してください。ブラウザが異なると、計算ロジックが異なる場合があります。
使用例
download.suggestedFilename();
戻り値
url
v1.9 より前に追加ダウンロードされた URL を返します。
使用例
download.url();
戻り値