LaunchOptions 接口

args

optional

string[]

要传递给浏览器实例的附加命令行参数。

browser

optional

SupportedBrowser

要启动哪个浏览器。

chrome

channel

optional

ChromeReleaseChannel

如果为 Chrome 指定，则会在已知的系统位置查找常规的 Chrome 安装，而不是使用捆绑的 Chrome 二进制文件。

debuggingPort

optional

number

指定要使用的调试端口号

devtools

optional

boolean

是否自动为每个标签页打开 DevTools 面板。如果将其设置为 true，则 headless 将被强制设为 false。

false

dumpio

optional

boolean

如果为 true，则将浏览器进程的 stdout 和 stderr 通过管道输出到 process.stdout 和 process.stderr。

false

enableExtensions

optional

boolean | string[]

如果为 true，则避免向浏览器传递会阻止启用扩展的默认参数。传递字符串列表将以未打包扩展的形式加载所提供的路径。

env

optional

Record<string, string | undefined>

指定对浏览器可见的环境变量。

process.env 的内容。

executablePath

optional

string

要使用的浏览器可执行文件路径，代替捆绑的浏览器。请注意，Puppeteer 只保证与捆绑的浏览器兼容，因此使用此设置的风险自负。

备注：

使用此设置时，建议同时设置 browser 属性，因为 Puppeteer 默认情况下会默认使用 chrome。

extensionsEnabledInIncognito

optional

string[]

将在隐身模式（Incognito）和无痕（off-the-record）配置文件中启用的扩展列表。

extraPrefsFirefox

optional

Record<string, unknown>

使用 Firefox 启动时可以传递的附加首选项。

handleSIGHUP

optional

boolean

在收到 SIGHUP 时关闭浏览器进程。

true

handleSIGINT

optional

boolean

在按下 Ctrl+C 时关闭浏览器进程。

true

handleSIGTERM

optional

boolean

在收到 SIGTERM 时关闭浏览器进程。

true

headless

optional

boolean | 'shell'

是否以无头模式运行浏览器。

备注：

• true 以新的无头模式启动浏览器。

• 'shell' 启动shell，即旧的无头模式。

true

ignoreDefaultArgs

optional

boolean | string[]

如果为 true，则在创建浏览器时不使用 puppeteer.defaultArgs()。如果提供了数组，则这些参数将被过滤掉。请谨慎使用此选项——你可能需要 Puppeteer 使用的默认参数。

false

pipe

optional

boolean

通过管道而非 WebSocket 连接到浏览器。仅支持 Chrome。

false

signal

optional

AbortSignal

如果提供了该信号，则当信号被中止时，浏览器将被关闭。

timeout

optional

number

等待浏览器启动的最大毫秒数。传递 0 可禁用超时。

30_000（30 秒）。

userDataDir

optional

string

用户数据目录的路径。更多信息请参阅 Chromium 文档。

waitForInitialPage

optional

boolean

是否等待初始页面就绪。当用户显式禁用该行为时（例如 Chrome 的 --no-startup-window）很有用。

true