Загрузка

Объекты загрузки отправляются страницей через событие 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​

Отменяет загрузку. Не вызовет ошибку, если загрузка уже завершена или отменена. В случае успешной отмены, download.failure() будет разрешено в 'canceled'.

Использование

await download.cancel();

Возвращает

• Promise<void>

createReadStream​

Возвращает потоковый объект чтения для успешной загрузки или генерирует ошибку для неудачной/отменённой загрузки.

Использование

await download.createReadStream();

Возвращает

• Promise<Readable>

delete​

Удаляет загруженный файл. Подождёт завершения загрузки, если необходимо.

Использование

await download.delete();

Возвращает

• Promise<void>

failure​

Возвращает ошибку загрузки, если она произошла. Подождёт завершения загрузки, если необходимо.

Использование

await download.failure();

Возвращает

• Promise<null | строка>

page​

Получить страницу, к которой относится загрузка.

Использование

download.page();

Возвращает

• Страница

path​

Возвращает путь к загруженному файлу для успешной загрузки или выбрасывает исключение для неудачной/отменённой загрузки. Метод ожидает завершения загрузки, если необходимо. Метод выбрасывает исключение при удалённом соединении.

Обратите внимание, что имя файла загрузки — случайный GUID. Используйте download.suggestedFilename(), чтобы получить предложенное имя файла.

Использование

await download.path();

Возвращает

• Promise<строка>

saveAs​

Копирует загрузку в указанный пользователем путь. Безопасно вызывать этот метод, пока загрузка ещё выполняется. Подождёт завершения загрузки, если необходимо.

Использование

await download.saveAs('/path/to/save/at/' + download.suggestedFilename());

Аргументы

• path строка

  Путь, куда нужно скопировать загрузку.

Возвращает

• Promise<void>

suggestedFilename​

Возвращает предложенное имя файла для данной загрузки. Обычно вычисляется браузером из заголовка ответа Content-Disposition или атрибута download. См. спецификацию на whatwg. Разные браузеры могут использовать разную логику для его вычисления.

Использование

download.suggestedFilename();

Возвращает

• строка

url​

Возвращает URL загруженного файла.

Использование

download.url();

Возвращает

• строка