Skip to main content
Version: 23.11.0

ConnectOptions interface

Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.

Signature

export interface ConnectOptions

Properties

Property

Modifiers

Type

Description

Default

acceptInsecureCerts

optional

boolean

Whether to ignore HTTPS errors during navigation.

false

browserURL

optional

string

browserWSEndpoint

optional

string

capabilities

optional

SupportedWebDriverCapabilities

WebDriver BiDi capabilities passed to BiDi session.new.

Remarks:

Only works for protocol="webDriverBiDi" and Puppeteer.connect().

defaultViewport

optional

Viewport | null

Sets the viewport for each page.

'{width: 800, height: 600}'

downloadBehavior

optional

DownloadBehavior

Sets the download behavior for the context.

headers

optional

Record<string, string>

Headers to use for the web socket connection.

Remarks:

Only works in the Node.js environment.

protocol

optional

ProtocolType

Determined at run time:

  • Launching Chrome - 'cdp'.

  • Launching Firefox - 'webDriverBiDi'.

  • Connecting to a browser - 'cdp'.

protocolTimeout

optional

number

Timeout setting for individual protocol (CDP) calls.

180_000

slowMo

optional

number

Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging.

targetFilter

optional

TargetFilterCallback

Callback to decide if Puppeteer should connect to a given target or not.

transport

optional

ConnectionTransport