2022-07-05 13:41:43 +00:00
|
|
|
---
|
|
|
|
sidebar_label: BrowserConnectOptions
|
|
|
|
---
|
|
|
|
|
|
|
|
# BrowserConnectOptions interface
|
|
|
|
|
|
|
|
Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.
|
|
|
|
|
2022-10-24 07:07:05 +00:00
|
|
|
#### Signature:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```typescript
|
|
|
|
export interface BrowserConnectOptions
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
<table><thead><tr><th>
|
|
|
|
|
|
|
|
Property
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Modifiers
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Default
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="defaultviewport">defaultViewport</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Viewport](./puppeteer.viewport.md) \| null
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Sets the viewport for each page.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
'{width: 800, height: 600}'
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="ignorehttpserrors">ignoreHTTPSErrors</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether to ignore HTTPS errors during navigation.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`false`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="protocol">protocol</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[ProtocolType](./puppeteer.protocoltype.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
'cdp'
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="protocoltimeout">protocolTimeout</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Timeout setting for individual protocol (CDP) calls.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`180_000`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="slowmo">slowMo</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="targetfilter">targetFilter</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[TargetFilterCallback](./puppeteer.targetfiltercallback.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Callback to decide if Puppeteer should connect to a given target or not.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|