chore: revert "chore: release main" (#9155)

Reverts puppeteer/puppeteer#9152
This commit is contained in:
jrandolf 2022-10-24 16:23:24 +02:00 committed by GitHub
parent 10b59a9a63
commit 95d77c679c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
746 changed files with 1263 additions and 1739 deletions

View File

@ -1,5 +1,5 @@
{
"packages/puppeteer": "19.1.1",
"packages/puppeteer-core": "19.1.1",
"packages/puppeteer": "19.1.0",
"packages/puppeteer-core": "19.1.0",
"packages/testserver": "0.6.0"
}

8
package-lock.json generated
View File

@ -8464,7 +8464,7 @@
}
},
"packages/puppeteer": {
"version": "19.1.1",
"version": "19.1.0",
"hasInstallScript": true,
"license": "Apache-2.0",
"dependencies": {
@ -8472,14 +8472,14 @@
"https-proxy-agent": "5.0.1",
"progress": "2.0.3",
"proxy-from-env": "1.1.0",
"puppeteer-core": "19.1.1"
"puppeteer-core": "19.1.0"
},
"engines": {
"node": ">=14.1.0"
}
},
"packages/puppeteer-core": {
"version": "19.1.1",
"version": "19.1.0",
"license": "Apache-2.0",
"dependencies": {
"cross-fetch": "3.1.5",
@ -13301,7 +13301,7 @@
"https-proxy-agent": "5.0.1",
"progress": "2.0.3",
"proxy-from-env": "1.1.0",
"puppeteer-core": "19.1.1"
"puppeteer-core": "19.1.0"
}
},
"puppeteer-core": {

View File

@ -2,13 +2,6 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
## [19.1.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.1.0...puppeteer-core-v19.1.1) (2022-10-24)
### Bug Fixes
* update documentation on configuring puppeteer ([#9150](https://github.com/puppeteer/puppeteer/issues/9150)) ([f07ad2c](https://github.com/puppeteer/puppeteer/commit/f07ad2c6616ecd2a959b0c1a65b167ba77611d61))
## [19.1.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.0.0...puppeteer-core-v19.1.0) (2022-10-21)

View File

@ -1,6 +1,6 @@
{
"name": "puppeteer-core",
"version": "19.1.1",
"version": "19.1.0",
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
"keywords": [
"puppeteer",

View File

@ -2,12 +2,6 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
### Dependencies
* The following workspace dependencies were updated
* dependencies
* puppeteer-core bumped from 19.1.0 to ^19.1.1
## [19.1.0](https://github.com/puppeteer/puppeteer/compare/v19.0.0...v19.1.0) (2022-10-21)

View File

@ -1,6 +1,6 @@
{
"name": "puppeteer",
"version": "19.1.1",
"version": "19.1.0",
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
"keywords": [
"puppeteer",
@ -139,6 +139,6 @@
"https-proxy-agent": "5.0.1",
"progress": "2.0.3",
"proxy-from-env": "1.1.0",
"puppeteer-core": "19.1.1"
"puppeteer-core": "19.1.0"
}
}

View File

@ -73,7 +73,7 @@ sidebar_label: API
| [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) | |
| [ClickOptions](./puppeteer.clickoptions.md) | |
| [CommonEventEmitter](./puppeteer.commoneventemitter.md) | |
| [Configuration](./puppeteer.configuration.md) | <p>Defines options to configure Puppeteer's behavior during installation and runtime.</p><p>See individual properties for more information.</p> |
| [Configuration](./puppeteer.configuration.md) | |
| [ConnectionCallback](./puppeteer.connectioncallback.md) | |
| [ConnectionTransport](./puppeteer.connectiontransport.md) | |
| [ConnectOptions](./puppeteer.connectoptions.md) | |
@ -84,7 +84,6 @@ sidebar_label: API
| [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. |
| [CustomQueryHandler](./puppeteer.customqueryhandler.md) | |
| [Device](./puppeteer.device.md) | |
| [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | <p>Defines experiment options for Puppeteer.</p><p>See individual properties for more information.</p> |
| [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | |
| [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | |
| [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | |

View File

@ -6,7 +6,7 @@ sidebar_label: Accessibility
The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access).
#### Signature:
**Signature:**
```typescript
export declare class Accessibility

View File

@ -6,7 +6,7 @@ sidebar_label: Accessibility.snapshot
Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
#### Signature:
**Signature:**
```typescript
class Accessibility {

View File

@ -4,7 +4,7 @@ sidebar_label: ActionResult
# ActionResult type
#### Signature:
**Signature:**
```typescript
export declare type ActionResult = 'continue' | 'abort' | 'respond';

View File

@ -4,7 +4,7 @@ sidebar_label: Awaitable
# Awaitable type
#### Signature:
**Signature:**
```typescript
export declare type Awaitable<T> = T | PromiseLike<T>;

View File

@ -6,7 +6,7 @@ sidebar_label: BoundingBox.height
the height of the element in pixels.
#### Signature:
**Signature:**
```typescript
interface BoundingBox {

View File

@ -4,7 +4,7 @@ sidebar_label: BoundingBox
# BoundingBox interface
#### Signature:
**Signature:**
```typescript
export interface BoundingBox extends Point
@ -14,7 +14,7 @@ export interface BoundingBox extends Point
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------- | --------- | ------ | ------------------------------------ | ------- |
| [height](./puppeteer.boundingbox.height.md) | | number | the height of the element in pixels. | |
| [width](./puppeteer.boundingbox.width.md) | | number | the width of the element in pixels. | |
| Property | Modifiers | Type | Description |
| ------------------------------------------- | --------- | ------ | ------------------------------------ |
| [height](./puppeteer.boundingbox.height.md) | | number | the height of the element in pixels. |
| [width](./puppeteer.boundingbox.width.md) | | number | the width of the element in pixels. |

View File

@ -6,7 +6,7 @@ sidebar_label: BoundingBox.width
the width of the element in pixels.
#### Signature:
**Signature:**
```typescript
interface BoundingBox {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.border
# BoxModel.border property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.content
# BoxModel.content property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.height
# BoxModel.height property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.margin
# BoxModel.margin property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel
# BoxModel interface
#### Signature:
**Signature:**
```typescript
export interface BoxModel
@ -12,11 +12,11 @@ export interface BoxModel
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------ | --------- | --------------------------------- | ----------- | ------- |
| [border](./puppeteer.boxmodel.border.md) | | [Point](./puppeteer.point.md)\[\] | | |
| [content](./puppeteer.boxmodel.content.md) | | [Point](./puppeteer.point.md)\[\] | | |
| [height](./puppeteer.boxmodel.height.md) | | number | | |
| [margin](./puppeteer.boxmodel.margin.md) | | [Point](./puppeteer.point.md)\[\] | | |
| [padding](./puppeteer.boxmodel.padding.md) | | [Point](./puppeteer.point.md)\[\] | | |
| [width](./puppeteer.boxmodel.width.md) | | number | | |
| Property | Modifiers | Type | Description |
| ------------------------------------------ | --------- | --------------------------------- | ----------- |
| [border](./puppeteer.boxmodel.border.md) | | [Point](./puppeteer.point.md)\[\] | |
| [content](./puppeteer.boxmodel.content.md) | | [Point](./puppeteer.point.md)\[\] | |
| [height](./puppeteer.boxmodel.height.md) | | number | |
| [margin](./puppeteer.boxmodel.margin.md) | | [Point](./puppeteer.point.md)\[\] | |
| [padding](./puppeteer.boxmodel.padding.md) | | [Point](./puppeteer.point.md)\[\] | |
| [width](./puppeteer.boxmodel.width.md) | | number | |

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.padding
# BoxModel.padding property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -4,7 +4,7 @@ sidebar_label: BoxModel.width
# BoxModel.width property
#### Signature:
**Signature:**
```typescript
interface BoxModel {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.browserContexts
Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md).
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.close
Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.createIncognitoBrowserContext
Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.defaultBrowserContext
Returns the default browser context. The default browser context cannot be closed.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.disconnect
Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.isConnected
Indicates that the browser is connected.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser
A Browser is created when Puppeteer connects to a Chromium instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).
#### Signature:
**Signature:**
```typescript
export declare class Browser extends EventEmitter

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.newPage
Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.pages
An array of all open pages inside the Browser.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.process
The spawned browser process. Returns `null` if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.target
The target associated with the browser.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.targets
All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.userAgent
The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.version
A string representing the browser name and version.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.waitForTarget
Searches for a target in all browser contexts.
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: Browser.wsEndpoint
The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).
#### Signature:
**Signature:**
```typescript
class Browser {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.defaultViewport
Sets the viewport for each page.
#### Signature:
**Signature:**
```typescript
interface BrowserConnectOptions {

View File

@ -6,14 +6,10 @@ sidebar_label: BrowserConnectOptions.ignoreHTTPSErrors
Whether to ignore HTTPS errors during navigation.
#### Signature:
**Signature:**
```typescript
interface BrowserConnectOptions {
ignoreHTTPSErrors?: boolean;
}
```
#### Default value:
false

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions
Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.
#### Signature:
**Signature:**
```typescript
export interface BrowserConnectOptions
@ -14,9 +14,9 @@ export interface BrowserConnectOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | <i>(Optional)</i> Sets the viewport for each page. | |
| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | <i>(Optional)</i> Whether to ignore HTTPS errors during navigation. | false |
| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | <i>(Optional)</i> Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | <i>(Optional)</i> Callback to decide if Puppeteer should connect to a given target or not. | |
| Property | Modifiers | Type | Description |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | <i>(Optional)</i> Sets the viewport for each page. |
| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | <i>(Optional)</i> Whether to ignore HTTPS errors during navigation. |
| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | <i>(Optional)</i> Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. |
| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | <i>(Optional)</i> Callback to decide if Puppeteer should connect to a given target or not. |

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.slowMo
Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging.
#### Signature:
**Signature:**
```typescript
interface BrowserConnectOptions {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.targetFilter
Callback to decide if Puppeteer should connect to a given target or not.
#### Signature:
**Signature:**
```typescript
interface BrowserConnectOptions {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.browser
The browser this browser context belongs to.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.clearPermissionOverrides
Clears all permission overrides for the browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.close
Closes the browser context. All the targets that belong to the browser context will be closed.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserContext.id
# BrowserContext.id property
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.isIncognito
Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext
BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context.
#### Signature:
**Signature:**
```typescript
export declare class BrowserContext extends EventEmitter

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.newPage
Creates a new page in the browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserContext.overridePermissions
# BrowserContext.overridePermissions() method
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.pages
An array of all pages inside the browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.targets
An array of all active targets inside the browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContext.waitForTarget
This searches for a target in this specific browser context.
#### Signature:
**Signature:**
```typescript
class BrowserContext {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserContextEmittedEvents
# BrowserContextEmittedEvents enum
#### Signature:
**Signature:**
```typescript
export declare const enum BrowserContextEmittedEvents

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions
BrowserContext options.
#### Signature:
**Signature:**
```typescript
export interface BrowserContextOptions
@ -14,7 +14,7 @@ export interface BrowserContextOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------------ | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | <i>(Optional)</i> Bypass the proxy for the given list of hosts. | |
| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | <i>(Optional)</i> Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. | |
| Property | Modifiers | Type | Description |
| ------------------------------------------------------------------------ | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | <i>(Optional)</i> Bypass the proxy for the given list of hosts. |
| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | <i>(Optional)</i> Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. |

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions.proxyBypassList
Bypass the proxy for the given list of hosts.
#### Signature:
**Signature:**
```typescript
interface BrowserContextOptions {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions.proxyServer
Proxy server with optional port to use for all requests. Username and password can be set in `Page.authenticate`.
#### Signature:
**Signature:**
```typescript
interface BrowserContextOptions {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserEmittedEvents
All the events a [browser instance](./puppeteer.browser.md) may emit.
#### Signature:
**Signature:**
```typescript
export declare const enum BrowserEmittedEvents

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.(constructor)
Constructs a browser fetcher for the given options.
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.canDownload
Initiates a HEAD request to check if the revision is available.
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.download
Initiates a GET request to download the revision from the host.
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.host
# BrowserFetcher.host() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.localRevisions
# BrowserFetcher.localRevisions() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher
BrowserFetcher can download and manage different versions of Chromium and Firefox.
#### Signature:
**Signature:**
```typescript
export declare class BrowserFetcher

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.platform
# BrowserFetcher.platform() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.product
# BrowserFetcher.product() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.remove
# BrowserFetcher.remove() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.revisionInfo
# BrowserFetcher.revisionInfo() method
#### Signature:
**Signature:**
```typescript
class BrowserFetcher {

View File

@ -6,16 +6,10 @@ sidebar_label: BrowserFetcherOptions.host
Determines the host that will be used for downloading.
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherOptions {
host?: string;
}
```
#### Default value:
Either
- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherOptions
# BrowserFetcherOptions interface
#### Signature:
**Signature:**
```typescript
export interface BrowserFetcherOptions
@ -12,10 +12,10 @@ export interface BrowserFetcherOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | <i>(Optional)</i> Determines the host that will be used for downloading. | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
| [path](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | |
| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | <i>(Optional)</i> Determines which platform the browser will be suited for. | Auto-detected. |
| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | <i>(Optional)</i> Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>. |
| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | <i>(Optional)</i> Enables the use of the Chromium binary for macOS ARM. | |
| Property | Modifiers | Type | Description |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | <i>(Optional)</i> Determines the host that will be used for downloading. |
| [path](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. |
| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | <i>(Optional)</i> Determines which platform the browser will be suited for. |
| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | <i>(Optional)</i> Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. |
| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | <i>(Optional)</i> Enables the use of the Chromium binary for macOS ARM. |

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcherOptions.path
Determines the path to download browsers to.
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherOptions {

View File

@ -6,14 +6,10 @@ sidebar_label: BrowserFetcherOptions.platform
Determines which platform the browser will be suited for.
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherOptions {
platform?: Platform;
}
```
#### Default value:
Auto-detected.

View File

@ -6,14 +6,10 @@ sidebar_label: BrowserFetcherOptions.product
Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for.
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherOptions {
product?: 'chrome' | 'firefox';
}
```
#### Default value:
`"chrome"`.

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserFetcherOptions.useMacOSARMBinary
Enables the use of the Chromium binary for macOS ARM.
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherOptions {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.executablePath
# BrowserFetcherRevisionInfo.executablePath property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.folderPath
# BrowserFetcherRevisionInfo.folderPath property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.local
# BrowserFetcherRevisionInfo.local property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo
# BrowserFetcherRevisionInfo interface
#### Signature:
**Signature:**
```typescript
export interface BrowserFetcherRevisionInfo
@ -12,11 +12,11 @@ export interface BrowserFetcherRevisionInfo
## Properties
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------------------- | --------- | ------- | ----------- | ------- |
| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | | string | | |
| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | | string | | |
| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | | boolean | | |
| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | | string | | |
| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | | string | | |
| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | | string | | |
| Property | Modifiers | Type | Description |
| -------------------------------------------------------------------------- | --------- | ------- | ----------- |
| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | | string | |
| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | | string | |
| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | | boolean | |
| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | | string | |
| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | | string | |
| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | | string | |

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.product
# BrowserFetcherRevisionInfo.product property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.revision
# BrowserFetcherRevisionInfo.revision property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.url
# BrowserFetcherRevisionInfo.url property
#### Signature:
**Signature:**
```typescript
interface BrowserFetcherRevisionInfo {

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions.args
Additional command line arguments to pass to the browser instance.
#### Signature:
**Signature:**
```typescript
interface BrowserLaunchArgumentOptions {

View File

@ -4,7 +4,7 @@ sidebar_label: BrowserLaunchArgumentOptions.debuggingPort
# BrowserLaunchArgumentOptions.debuggingPort property
#### Signature:
**Signature:**
```typescript
interface BrowserLaunchArgumentOptions {

View File

@ -6,14 +6,10 @@ sidebar_label: BrowserLaunchArgumentOptions.devtools
Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be forced to `false`.
#### Signature:
**Signature:**
```typescript
interface BrowserLaunchArgumentOptions {
devtools?: boolean;
}
```
#### Default value:
`false`

View File

@ -6,14 +6,10 @@ sidebar_label: BrowserLaunchArgumentOptions.headless
Whether to run the browser in headless mode.
#### Signature:
**Signature:**
```typescript
interface BrowserLaunchArgumentOptions {
headless?: boolean | 'chrome';
}
```
#### Default value:
true

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions
Launcher options that only apply to Chrome.
#### Signature:
**Signature:**
```typescript
export interface BrowserLaunchArgumentOptions
@ -14,10 +14,10 @@ export interface BrowserLaunchArgumentOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------------- | --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | <i>(Optional)</i> Additional command line arguments to pass to the browser instance. | |
| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | <i>(Optional)</i> | |
| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | <i>(Optional)</i> Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. | <code>false</code> |
| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'chrome' | <i>(Optional)</i> Whether to run the browser in headless mode. | true |
| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | <i>(Optional)</i> Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | |
| Property | Modifiers | Type | Description |
| --------------------------------------------------------------------------- | --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | <i>(Optional)</i> Additional command line arguments to pass to the browser instance. |
| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | <i>(Optional)</i> |
| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | <i>(Optional)</i> Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. |
| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'chrome' | <i>(Optional)</i> Whether to run the browser in headless mode. |
| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | <i>(Optional)</i> Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. |

View File

@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions.userDataDir
Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info.
#### Signature:
**Signature:**
```typescript
interface BrowserLaunchArgumentOptions {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSession.connection
# CDPSession.connection() method
#### Signature:
**Signature:**
```typescript
class CDPSession {

View File

@ -6,7 +6,7 @@ sidebar_label: CDPSession.detach
Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages.
#### Signature:
**Signature:**
```typescript
class CDPSession {

View File

@ -6,7 +6,7 @@ sidebar_label: CDPSession.id
Returns the session's id.
#### Signature:
**Signature:**
```typescript
class CDPSession {

View File

@ -6,7 +6,7 @@ sidebar_label: CDPSession
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol.
#### Signature:
**Signature:**
```typescript
export declare class CDPSession extends EventEmitter

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSession.send
# CDPSession.send() method
#### Signature:
**Signature:**
```typescript
class CDPSession {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.error
# CDPSessionOnMessageObject.error property
#### Signature:
**Signature:**
```typescript
interface CDPSessionOnMessageObject {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.id
# CDPSessionOnMessageObject.id property
#### Signature:
**Signature:**
```typescript
interface CDPSessionOnMessageObject {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject
# CDPSessionOnMessageObject interface
#### Signature:
**Signature:**
```typescript
export interface CDPSessionOnMessageObject
@ -12,10 +12,10 @@ export interface CDPSessionOnMessageObject
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | --------------------------------------------- | ----------------- | ------- |
| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | |
| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | <i>(Optional)</i> | |
| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | |
| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record&lt;string, unknown&gt; | | |
| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description |
| ---------------------------------------------------------- | --------- | --------------------------------------------- | ----------------- |
| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | |
| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | <i>(Optional)</i> |
| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | |
| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record&lt;string, unknown&gt; | |
| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | <i>(Optional)</i> |

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.method
# CDPSessionOnMessageObject.method property
#### Signature:
**Signature:**
```typescript
interface CDPSessionOnMessageObject {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.params
# CDPSessionOnMessageObject.params property
#### Signature:
**Signature:**
```typescript
interface CDPSessionOnMessageObject {

View File

@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.result
# CDPSessionOnMessageObject.result property
#### Signature:
**Signature:**
```typescript
interface CDPSessionOnMessageObject {

View File

@ -4,7 +4,7 @@ sidebar_label: ChromeReleaseChannel
# ChromeReleaseChannel type
#### Signature:
**Signature:**
```typescript
export declare type ChromeReleaseChannel =

View File

@ -8,7 +8,7 @@ sidebar_label: clearCustomQueryHandlers
>
> Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.clearCustomQueryHandlers()](./puppeteer.puppeteer.clearcustomqueryhandlers.md)
#### Signature:
**Signature:**
```typescript
export declare function clearCustomQueryHandlers(): void;

Some files were not shown because too many files have changed in this diff Show More