跳至主要內容
版本: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

選用

string

要使用的瀏覽器可執行檔路徑,而不是捆綁的瀏覽器。請注意,Puppeteer 僅保證可與捆綁的瀏覽器搭配運作,因此請自行承擔使用此設定的風險。

備註

使用此項時,建議您也設定 browser 屬性,因為 Puppeteer 預設會使用 chrome

extraPrefsFirefox

選用

Record<string, unknown>

啟動 Firefox 時可以傳遞的其他偏好設定

handleSIGHUP

選用

boolean

SIGHUP 時關閉瀏覽器處理程序。

true

handleSIGINT

選用

boolean

Ctrl+C 時關閉瀏覽器處理程序。

true

handleSIGTERM

選用

boolean

SIGTERM 時關閉瀏覽器處理程序。

true

headless

選用

boolean | 'shell'

是否以無頭模式執行瀏覽器。

備註

  • true 會以新的無頭模式啟動瀏覽器。

  • 'shell' 會啟動稱為舊版無頭模式的 shell

true

ignoreDefaultArgs

選用

boolean | string[]

如果為 true,則建立瀏覽器時不要使用 puppeteer.defaultArgs()。如果提供陣列,則會篩除這些引數。請謹慎使用此項 - 您可能需要 Puppeteer 使用的預設引數。

false

pipe

選用

boolean

透過管道而非 WebSocket 連接到瀏覽器。僅 Chrome 支援。

false

timeout

選用

number

等待瀏覽器啟動的最長時間 (毫秒)。傳遞 0 以停用逾時。

30_000 (30 秒)。

userDataDir

選用

string

使用者資料目錄的路徑。如需詳細資訊,請參閱 Chromium 文件

waitForInitialPage

選用

boolean

是否等待初始頁面準備就緒。當使用者明確停用時 (例如 Chrome 的 --no-startup-window) 非常有用。

true