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​

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

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

await download.cancel();

Возвращает

• Promise<void>

createReadStream​

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

примечание

Если вам не нужен поток для чтения, обычно проще прочитать файл с диска после завершения загрузки. См. download.path().

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

await download.createReadStream();

Возвращает

• Promise<Readable>

delete​

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

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

await download.delete();

Возвращает

• Promise<void>

failure​

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

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

await download.failure();

Возвращает

• Promise<null | string>

page​

Возвращает страницу, к которой относится загрузка.

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

download.page();

Возвращает

• Page

path​

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

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

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

await download.path();

Возвращает

• Promise<string>

saveAs​

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

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

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

Аргументы

• path string

  Путь, по которому следует скопировать загруженный файл.

Возвращает

• Promise<void>

suggestedFilename​

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

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

download.suggestedFilename();

Возвращает

• string

url​

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

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

download.url();

Возвращает

• string