Puppeteer 中文文档v25.8.0

InstallOptions 接口

签名

export interface InstallOptions

属性

属性

修饰符

类型

说明

默认值

baseUrl

optional

string

确定用于下载的主机。

以下任一:

browser

Browser

确定要安装哪个浏览器。

buildId

string

确定要下载哪个 buildId。buildId 应唯一标识二进制文件,它们用于缓存。

buildIdAlias

optional

string

所提供 buildId 的别名。它将用于维护本地元数据,以支持 launch 命令中的别名。

cacheDir

string

确定浏览器下载到的路径。

downloadProgressCallback

optional

'default' | ((downloadedBytes: number, totalBytes: number) => void)

提供有关下载进度的信息。如果设置为 'default',将使用实现进度条的默认回调。

expectedHash

optional

string

下载的浏览器归档的预期 SHA-256 校验和(小写十六进制)。如果提供,则当下载的文件不匹配时安装将失败。如果省略,则下载将继续进行,不进行完整性验证。

installDeps

optional

boolean

是否尝试安装浏览器所需的系统级依赖。

仅支持 Debian 或 Ubuntu 上的 Chrome。需要系统级权限才能运行 apt-get

false

logger

optional

Logger

platform

optional

BrowserPlatform

确定浏览器将适配哪个平台。

自动检测。

providers

optional

BrowserProvider[]

用于备选下载源的自定义 provider 实现。

如果未提供,则使用默认 provider。多个 provider 可以串联 - 将按顺序依次尝试。默认 provider 会自动添加为最终的兜底。

⚠️ 重要:自定义 provider 不受 Puppeteer 官方支持。

使用自定义 provider,即表示您接受以下全部责任:

  • 版本兼容性:不同平台可能收到不同的二进制版本 - 归档兼容性:二进制结构必须符合 Puppeteer 的预期 - 功能集成:浏览器启动和其他 Puppeteer 功能可能无法正常工作 - 测试:您必须验证下载的二进制文件能与 Puppeteer 配合工作

Puppeteer 仅测试并保证与默认二进制文件的兼容性。

unpack

optional

boolean

是否解压并安装浏览器归档。

true