Download
Downloadオブジェクトは、pageの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以前成功したダウンロードの読み取り可能なストリームを返します。失敗またはキャンセルされたダウンロードの場合は例外をスローします。
使用方法
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();
戻り値