跳到主要内容
版本: 23.11.1

LaunchOptions 接口

启动任何浏览器时可以传递的通用启动选项。

签名

export interface LaunchOptions extends ConnectOptions

继承自: ConnectOptions

属性

属性

修饰符

类型

描述

默认值

args

可选

string[]

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

browser

可选

SupportedBrowser

要启动的浏览器。

chrome

channel

可选

ChromeReleaseChannel

Chrome 发布渠道

debuggingPort

可选

number

指定要使用的调试端口号

devtools

可选

boolean

是否为每个选项卡自动打开 DevTools 面板。如果将其设置为 true,则 headless 将强制设置为 false

false

dumpio

可选

boolean

如果为 true,则将浏览器进程的 stdout 和 stderr 管道到 process.stdoutprocess.stderr

false

env

可选

Record<string, string | undefined>

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

process.env 的内容。

executablePath

可选

executablePath

string

要使用的浏览器可执行文件的路径,而不是捆绑的浏览器。请注意,Puppeteer 仅保证与捆绑的浏览器一起工作,因此使用此设置的风险自负。

备注

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

可选

extraPrefsFirefox

Record<string, unknown>

启动 Firefox 时可以传递的其他首选项

可选

boolean

handleSIGHUP

SIGHUP 上关闭浏览器进程。

true

可选

boolean

handleSIGINT

SIGHUP 上关闭浏览器进程。

Ctrl+C 上关闭浏览器进程。

可选

boolean

handleSIGTERM

SIGHUP 上关闭浏览器进程。

SIGTERM 上关闭浏览器进程。

可选

headless

boolean | 'shell'

要使用的浏览器可执行文件的路径,而不是捆绑的浏览器。请注意,Puppeteer 仅保证与捆绑的浏览器一起工作,因此使用此设置的风险自负。

  • 是否在无头模式下运行浏览器。

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

SIGHUP 上关闭浏览器进程。

'shell' 启动shell,也称为旧的无头模式。

可选

ignoreDefaultArgs

boolean | string[]

false

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

可选

boolean

pipe

false

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

可选

number

timeout

等待浏览器启动的最长时间(以毫秒为单位)。传递 0 以禁用超时。

30_000(30 秒)。

可选

executablePath

userDataDir

用户数据目录的路径。有关更多信息,请参见 Chromium 文档

可选

boolean

waitForInitialPage

SIGHUP 上关闭浏览器进程。