Skip to main content
Version: 24.4.0

LaunchOptions 接口

¥LaunchOptions interface

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

¥Generic launch options that can be passed when launching any browser.

签名

¥Signature

export interface LaunchOptions extends ConnectOptions

Extends: ConnectOptions

属性

¥Properties

属性

修饰符

类型

描述

默认

args

optional

string[]

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

browser

optional

SupportedBrowser

要启动哪个浏览器。

chrome

channel

optional

ChromeReleaseChannel

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

debuggingPort

optional

数字

指定要使用的调试端口号

devtools

optional

boolean

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

false

dumpio

optional

boolean

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

false

env

optional

记录<字符串,字符串| 未定义>

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

process.env 的内容。

可执行路径

optional

string

要使用的浏览器可执行文件的路径,而不是打包的浏览器。请注意,Puppeteer 仅保证与打包的浏览器一起使用,因此使用此设置需要你自担风险。

评论:

使用此功能时,建议设置 browser 属性,因为 Puppeteer 默认将默认为 chrome

extraPrefsFirefox

optional

记录<字符串,未知>

使用 Firefox 启动时可以传递 其他偏好

处理 SIGHUP

optional

boolean

关闭 SIGHUP 上的浏览器进程。

true

处理 SIGINT

optional

boolean

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

true

处理 SIGTERM

optional

boolean

关闭 SIGTERM 上的浏览器进程。

true

无头

optional

布尔 | 'shell'

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

评论:

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

  • 'shell' 推出了被称为老无头模式的 shell

true

ignoreDefaultArgs

optional

布尔 | 字符串[]

如果是 true,则创建浏览器时不要使用 puppeteer.defaultArgs()。如果提供了数组,这些参数将被过滤掉。小心使用这个 - 你可能需要 Puppeteer 使用的默认参数。

false

pipe

optional

boolean

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

false

timeout

optional

数字

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

30_000(30 秒)。

userDataDir

optional

string

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

waitForInitialPage

optional

boolean

是否等待初始页面准备好。当用户明确禁用该功能时很有用(例如 Chrome 的 --no-startup-window)。

true