chore: release main (#10108)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
This commit is contained in:
release-please[bot]
GitHub
parent
79d3ba09f7
commit
61605a0ed9
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"packages/puppeteer": "19.11.1",
|
"packages/puppeteer": "20.0.0",
|
||||||
"packages/puppeteer-core": "19.11.1",
|
"packages/puppeteer-core": "20.0.0",
|
||||||
"packages/testserver": "0.6.0",
|
"packages/testserver": "0.6.0",
|
||||||
"packages/ng-schematics": "0.1.0",
|
"packages/ng-schematics": "0.2.0",
|
||||||
"packages/browsers": "0.5.0"
|
"packages/browsers": "1.0.0"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -4,6 +4,7 @@ The following versions of Chromium are supported, mapped to Puppeteer version:
|
|||||||
|
|
||||||
<!-- version-start -->
|
<!-- version-start -->
|
||||||
|
|
||||||
|
- Chromium 112.0.5615.121 - [Puppeteer v20.0.0](https://pptr.dev/20.0.0)
|
||||||
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/v19.8.0/docs/api/index.md)
|
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/v19.8.0/docs/api/index.md)
|
||||||
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/v19.7.0/docs/api/index.md)
|
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/v19.7.0/docs/api/index.md)
|
||||||
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/v19.6.0/docs/api/index.md)
|
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/v19.6.0/docs/api/index.md)
|
||||||
|
|||||||
26
package-lock.json
generated
26
package-lock.json
generated
@ -9315,7 +9315,7 @@
|
|||||||
},
|
},
|
||||||
"packages/browsers": {
|
"packages/browsers": {
|
||||||
"name": "@puppeteer/browsers",
|
"name": "@puppeteer/browsers",
|
||||||
"version": "0.5.0",
|
"version": "1.0.0",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"debug": "4.3.4",
|
"debug": "4.3.4",
|
||||||
@ -9335,7 +9335,7 @@
|
|||||||
"@types/yargs": "17.0.22"
|
"@types/yargs": "17.0.22"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=14.1.0"
|
"node": ">=16.0.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"typescript": ">= 4.7.4"
|
"typescript": ">= 4.7.4"
|
||||||
@ -9353,7 +9353,7 @@
|
|||||||
},
|
},
|
||||||
"packages/ng-schematics": {
|
"packages/ng-schematics": {
|
||||||
"name": "@puppeteer/ng-schematics",
|
"name": "@puppeteer/ng-schematics",
|
||||||
"version": "0.1.0",
|
"version": "0.2.0",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@angular-devkit/architect": "^0.1502.7",
|
"@angular-devkit/architect": "^0.1502.7",
|
||||||
@ -9366,7 +9366,7 @@
|
|||||||
"@types/node": "^14.15.0"
|
"@types/node": "^14.15.0"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=14.1.0"
|
"node": ">=16.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"packages/ng-schematics/node_modules/@types/node": {
|
"packages/ng-schematics/node_modules/@types/node": {
|
||||||
@ -9375,23 +9375,23 @@
|
|||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
},
|
},
|
||||||
"packages/puppeteer": {
|
"packages/puppeteer": {
|
||||||
"version": "19.11.1",
|
"version": "20.0.0",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@puppeteer/browsers": "0.5.0",
|
"@puppeteer/browsers": "1.0.0",
|
||||||
"cosmiconfig": "8.1.3",
|
"cosmiconfig": "8.1.3",
|
||||||
"https-proxy-agent": "5.0.1",
|
"https-proxy-agent": "5.0.1",
|
||||||
"progress": "2.0.3",
|
"progress": "2.0.3",
|
||||||
"proxy-from-env": "1.1.0",
|
"proxy-from-env": "1.1.0",
|
||||||
"puppeteer-core": "19.11.1"
|
"puppeteer-core": "20.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"packages/puppeteer-core": {
|
"packages/puppeteer-core": {
|
||||||
"version": "19.11.1",
|
"version": "20.0.0",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@puppeteer/browsers": "0.5.0",
|
"@puppeteer/browsers": "1.0.0",
|
||||||
"chromium-bidi": "0.4.7",
|
"chromium-bidi": "0.4.7",
|
||||||
"cross-fetch": "3.1.5",
|
"cross-fetch": "3.1.5",
|
||||||
"debug": "4.3.4",
|
"debug": "4.3.4",
|
||||||
@ -9408,7 +9408,7 @@
|
|||||||
"parsel-js": "1.1.0"
|
"parsel-js": "1.1.0"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=14.14.0"
|
"node": ">=16.0.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"typescript": ">= 4.7.4"
|
"typescript": ">= 4.7.4"
|
||||||
@ -14370,18 +14370,18 @@
|
|||||||
"puppeteer": {
|
"puppeteer": {
|
||||||
"version": "file:packages/puppeteer",
|
"version": "file:packages/puppeteer",
|
||||||
"requires": {
|
"requires": {
|
||||||
"@puppeteer/browsers": "0.5.0",
|
"@puppeteer/browsers": "1.0.0",
|
||||||
"cosmiconfig": "8.1.3",
|
"cosmiconfig": "8.1.3",
|
||||||
"https-proxy-agent": "5.0.1",
|
"https-proxy-agent": "5.0.1",
|
||||||
"progress": "2.0.3",
|
"progress": "2.0.3",
|
||||||
"proxy-from-env": "1.1.0",
|
"proxy-from-env": "1.1.0",
|
||||||
"puppeteer-core": "19.11.1"
|
"puppeteer-core": "20.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"puppeteer-core": {
|
"puppeteer-core": {
|
||||||
"version": "file:packages/puppeteer-core",
|
"version": "file:packages/puppeteer-core",
|
||||||
"requires": {
|
"requires": {
|
||||||
"@puppeteer/browsers": "0.5.0",
|
"@puppeteer/browsers": "1.0.0",
|
||||||
"chromium-bidi": "0.4.7",
|
"chromium-bidi": "0.4.7",
|
||||||
"cross-fetch": "3.1.5",
|
"cross-fetch": "3.1.5",
|
||||||
"debug": "4.3.4",
|
"debug": "4.3.4",
|
||||||
|
|||||||
@ -1,5 +1,23 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [1.0.0](https://github.com/puppeteer/puppeteer/compare/browsers-v0.5.0...browsers-v1.0.0) (2023-05-02)
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠ BREAKING CHANGES
|
||||||
|
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019))
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019)) ([7405d65](https://github.com/puppeteer/puppeteer/commit/7405d6585aa09b240fbab09aa360674d4442b3d9))
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054)) ([df4d60c](https://github.com/puppeteer/puppeteer/commit/df4d60c187aa11c4ad783827242e9511f4ec2aab))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* add Host header when used with http_proxy ([#10080](https://github.com/puppeteer/puppeteer/issues/10080)) ([edbfff7](https://github.com/puppeteer/puppeteer/commit/edbfff7b04baffc29c01c37c595d6b3355c0dea0))
|
||||||
|
|
||||||
## [0.5.0](https://github.com/puppeteer/puppeteer/compare/browsers-v0.4.1...browsers-v0.5.0) (2023-04-21)
|
## [0.5.0](https://github.com/puppeteer/puppeteer/compare/browsers-v0.4.1...browsers-v0.5.0) (2023-04-21)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@puppeteer/browsers",
|
"name": "@puppeteer/browsers",
|
||||||
"version": "0.5.0",
|
"version": "1.0.0",
|
||||||
"description": "Download and launch browsers",
|
"description": "Download and launch browsers",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build:docs": "wireit",
|
"build:docs": "wireit",
|
||||||
|
|||||||
@ -1,5 +1,16 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [0.2.0](https://github.com/puppeteer/puppeteer/compare/ng-schematics-v0.1.0...ng-schematics-v0.2.0) (2023-05-02)
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠ BREAKING CHANGES
|
||||||
|
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019)) ([7405d65](https://github.com/puppeteer/puppeteer/commit/7405d6585aa09b240fbab09aa360674d4442b3d9))
|
||||||
|
|
||||||
## 0.1.0 (2022-11-23)
|
## 0.1.0 (2022-11-23)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
4
packages/ng-schematics/package-lock.json
generated
4
packages/ng-schematics/package-lock.json
generated
@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "angular",
|
"name": "angular",
|
||||||
"version": "0.1.0",
|
"version": "0.2.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "angular",
|
"name": "angular",
|
||||||
"version": "0.1.0",
|
"version": "0.2.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@angular-devkit/core": "^14.2.6",
|
"@angular-devkit/core": "^14.2.6",
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@puppeteer/ng-schematics",
|
"name": "@puppeteer/ng-schematics",
|
||||||
"version": "0.1.0",
|
"version": "0.2.0",
|
||||||
"description": "Puppeteer Angular schematics",
|
"description": "Puppeteer Angular schematics",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "wireit",
|
"build": "wireit",
|
||||||
|
|||||||
@ -2,6 +2,32 @@
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
## [20.0.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.11.1...puppeteer-core-v20.0.0) (2023-05-02)
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠ BREAKING CHANGES
|
||||||
|
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019))
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* add AbortSignal to waitForFunction ([#10078](https://github.com/puppeteer/puppeteer/issues/10078)) ([4dd4cb9](https://github.com/puppeteer/puppeteer/commit/4dd4cb929242a6b1a621fd461edd3167d40e1c4c))
|
||||||
|
* drop support for node14 ([#10019](https://github.com/puppeteer/puppeteer/issues/10019)) ([7405d65](https://github.com/puppeteer/puppeteer/commit/7405d6585aa09b240fbab09aa360674d4442b3d9))
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054)) ([df4d60c](https://github.com/puppeteer/puppeteer/commit/df4d60c187aa11c4ad783827242e9511f4ec2aab))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* use AbortSignal.throwIfAborted ([#10105](https://github.com/puppeteer/puppeteer/issues/10105)) ([575f00a](https://github.com/puppeteer/puppeteer/commit/575f00a31d0278f7ff27096e770ff84399cd9993))
|
||||||
|
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
* The following workspace dependencies were updated
|
||||||
|
* dependencies
|
||||||
|
* @puppeteer/browsers bumped from 0.5.0 to 1.0.0
|
||||||
|
|
||||||
## [19.11.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.11.0...puppeteer-core-v19.11.1) (2023-04-25)
|
## [19.11.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.11.0...puppeteer-core-v19.11.1) (2023-04-25)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "puppeteer-core",
|
"name": "puppeteer-core",
|
||||||
"version": "19.11.1",
|
"version": "20.0.0",
|
||||||
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
|
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"puppeteer",
|
"puppeteer",
|
||||||
@ -142,7 +142,7 @@
|
|||||||
"tar-fs": "2.1.1",
|
"tar-fs": "2.1.1",
|
||||||
"unbzip2-stream": "1.4.3",
|
"unbzip2-stream": "1.4.3",
|
||||||
"ws": "8.13.0",
|
"ws": "8.13.0",
|
||||||
"@puppeteer/browsers": "0.5.0"
|
"@puppeteer/browsers": "1.0.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"typescript": ">= 4.7.4"
|
"typescript": ">= 4.7.4"
|
||||||
|
|||||||
@ -8,6 +8,25 @@ All notable changes to this project will be documented in this file. See [standa
|
|||||||
* dependencies
|
* dependencies
|
||||||
* @puppeteer/browsers bumped from 0.3.0 to 0.3.1
|
* @puppeteer/browsers bumped from 0.3.0 to 0.3.1
|
||||||
|
|
||||||
|
## [20.0.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.11.1...puppeteer-v20.0.0) (2023-05-02)
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠ BREAKING CHANGES
|
||||||
|
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* switch to Chrome for Testing instead of Chromium ([#10054](https://github.com/puppeteer/puppeteer/issues/10054)) ([df4d60c](https://github.com/puppeteer/puppeteer/commit/df4d60c187aa11c4ad783827242e9511f4ec2aab))
|
||||||
|
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
* The following workspace dependencies were updated
|
||||||
|
* dependencies
|
||||||
|
* puppeteer-core bumped from 19.11.1 to 20.0.0
|
||||||
|
* @puppeteer/browsers bumped from 0.5.0 to 1.0.0
|
||||||
|
|
||||||
## [19.11.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.11.0...puppeteer-v19.11.1) (2023-04-25)
|
## [19.11.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.11.0...puppeteer-v19.11.1) (2023-04-25)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "puppeteer",
|
"name": "puppeteer",
|
||||||
"version": "19.11.1",
|
"version": "20.0.0",
|
||||||
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
|
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"puppeteer",
|
"puppeteer",
|
||||||
@ -120,7 +120,7 @@
|
|||||||
"https-proxy-agent": "5.0.1",
|
"https-proxy-agent": "5.0.1",
|
||||||
"progress": "2.0.3",
|
"progress": "2.0.3",
|
||||||
"proxy-from-env": "1.1.0",
|
"proxy-from-env": "1.1.0",
|
||||||
"puppeteer-core": "19.11.1",
|
"puppeteer-core": "20.0.0",
|
||||||
"@puppeteer/browsers": "0.5.0"
|
"@puppeteer/browsers": "1.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -17,7 +17,7 @@
|
|||||||
const versionsPerRelease = new Map([
|
const versionsPerRelease = new Map([
|
||||||
// This is a mapping from Chrome version => Puppeteer version.
|
// This is a mapping from Chrome version => Puppeteer version.
|
||||||
// In Chrome roll patches, use `NEXT` for the Puppeteer version.
|
// In Chrome roll patches, use `NEXT` for the Puppeteer version.
|
||||||
['112.0.5615.121', 'NEXT'],
|
['112.0.5615.121', 'v20.0.0'],
|
||||||
['112.0.5614.0', 'v19.8.0'],
|
['112.0.5614.0', 'v19.8.0'],
|
||||||
['111.0.5556.0', 'v19.7.0'],
|
['111.0.5556.0', 'v19.7.0'],
|
||||||
['110.0.5479.0', 'v19.6.0'],
|
['110.0.5479.0', 'v19.6.0'],
|
||||||
|
|||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: AbortError
|
|
||||||
---
|
|
||||||
|
|
||||||
# AbortError class
|
|
||||||
|
|
||||||
AbortError is emitted whenever certain operations are terminated due to an abort request.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export declare class AbortError extends CustomError
|
|
||||||
```
|
|
||||||
|
|
||||||
**Extends:** [CustomError](./puppeteer.customerror.md)
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
Example operations are [page.waitForSelector](./puppeteer.page.waitforselector.md).
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: Browser.disconnect
|
|
||||||
---
|
|
||||||
|
|
||||||
# Browser.disconnect() method
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class Browser {
|
|
||||||
disconnect(): void;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
void
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.(constructor)
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.(constructor)
|
|
||||||
|
|
||||||
Constructs a browser fetcher for the given options.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
constructor(options: BrowserFetcherOptions);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --------- | ------------------------------------------------------------- | ----------- |
|
|
||||||
| options | [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | |
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.canDownload
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.canDownload() method
|
|
||||||
|
|
||||||
Initiates a HEAD request to check if the revision is available.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
canDownload(revision: string): Promise<boolean>;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --------- | ------ | --------------------------------------- |
|
|
||||||
| revision | string | The revision to check availability for. |
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
Promise<boolean>
|
|
||||||
|
|
||||||
A promise that resolves to `true` if the revision could be downloaded from the host.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
This method is affected by the current `product`.
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.download
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.download() method
|
|
||||||
|
|
||||||
Initiates a GET request to download the revision from the host.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
download(
|
|
||||||
revision: string,
|
|
||||||
progressCallback?: (x: number, y: number) => void
|
|
||||||
): Promise<BrowserFetcherRevisionInfo | undefined>;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| ---------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| revision | string | The revision to download. |
|
|
||||||
| progressCallback | (x: number, y: number) => void | _(Optional)_ A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download. |
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
Promise<[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) \| undefined>
|
|
||||||
|
|
||||||
A promise with revision information when the revision is downloaded and extracted.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
This method is affected by the current `product`.
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.host
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.host() method
|
|
||||||
|
|
||||||
The download host being used.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
host(): string;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
string
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.localRevisions
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.localRevisions() method
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
localRevisions(): string[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
string\[\]
|
|
||||||
|
|
||||||
A list of all revision strings (for the current `product`) available locally on disk.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
This method is affected by the current `product`.
|
|
||||||
@ -1,48 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher class
|
|
||||||
|
|
||||||
BrowserFetcher can download and manage different versions of Chromium and Firefox.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export declare class BrowserFetcher
|
|
||||||
```
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const browserFetcher = new BrowserFetcher({path: 'path/to/download/folder'});
|
|
||||||
const revisionInfo = await browserFetcher.download('533271');
|
|
||||||
const browser = await puppeteer.launch({
|
|
||||||
executablePath: revisionInfo.executablePath,
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Constructors
|
|
||||||
|
|
||||||
| Constructor | Modifiers | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------- | --------------------------------------------------- |
|
|
||||||
| [(constructor)(options)](./puppeteer.browserfetcher._constructor_.md) | | Constructs a browser fetcher for the given options. |
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
| Method | Modifiers | Description |
|
|
||||||
| ------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. |
|
|
||||||
| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. |
|
|
||||||
| [host()](./puppeteer.browserfetcher.host.md) | | The download host being used. |
|
|
||||||
| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | |
|
|
||||||
| [platform()](./puppeteer.browserfetcher.platform.md) | | Returns the current <code>Platform</code>, which is one of <code>mac</code>, <code>linux</code>, <code>win32</code> or <code>win64</code>. |
|
|
||||||
| [product()](./puppeteer.browserfetcher.product.md) | | Returns the current <code>Product</code>, which is one of <code>chrome</code> or <code>firefox</code>. |
|
|
||||||
| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | |
|
|
||||||
| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | |
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.platform
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.platform() method
|
|
||||||
|
|
||||||
Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
platform(): Platform;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
[Platform](./puppeteer.platform.md)
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.product
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.product() method
|
|
||||||
|
|
||||||
Returns the current `Product`, which is one of `chrome` or `firefox`.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
product(): Product;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
[Product](./puppeteer.product.md)
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.remove
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.remove() method
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
remove(revision: string): Promise<void>;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --------- | ------ | ---------------------------------------------------------- |
|
|
||||||
| revision | string | A revision to remove for the current <code>product</code>. |
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
Promise<void>
|
|
||||||
|
|
||||||
A promise that resolves when the revision has been removed or throws if the revision has not been downloaded.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
This method is affected by the current `product`.
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcher.revisionInfo
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcher.revisionInfo() method
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class BrowserFetcher {
|
|
||||||
revisionInfo(revision: string): BrowserFetcherRevisionInfo;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --------- | ------ | ----------------------------- |
|
|
||||||
| revision | string | The revision to get info for. |
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)
|
|
||||||
|
|
||||||
The revision info for the given revision.
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcherOptions
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcherOptions interface
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export interface BrowserFetcherOptions
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
| Property | Modifiers | Type | Description | Default |
|
|
||||||
| ----------------- | --------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| host | <code>optional</code> | string | 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 | | string | Determines the path to download browsers to. | |
|
|
||||||
| platform | <code>optional</code> | [Platform](./puppeteer.platform.md) | Determines which platform the browser will be suited for. | **Auto-detected.** |
|
|
||||||
| product | <code>optional</code> | 'chrome' \| 'firefox' | Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>chrome</code> |
|
|
||||||
| useMacOSARMBinary | <code>optional</code> | boolean | Enables the use of the Chromium binary for macOS ARM. | |
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: BrowserFetcherRevisionInfo
|
|
||||||
---
|
|
||||||
|
|
||||||
# BrowserFetcherRevisionInfo interface
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export interface BrowserFetcherRevisionInfo
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
| Property | Modifiers | Type | Description | Default |
|
|
||||||
| -------------- | --------- | ------- | ----------- | ------- |
|
|
||||||
| executablePath | | string | | |
|
|
||||||
| folderPath | | string | | |
|
|
||||||
| local | | boolean | | |
|
|
||||||
| product | | string | | |
|
|
||||||
| revision | | string | | |
|
|
||||||
| url | | string | | |
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: createBrowserFetcher
|
|
||||||
---
|
|
||||||
|
|
||||||
# createBrowserFetcher variable
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
createBrowserFetcher: (
|
|
||||||
options?:
|
|
||||||
| Partial<
|
|
||||||
import('puppeteer-core/internal/puppeteer-core.js').BrowserFetcherOptions
|
|
||||||
>
|
|
||||||
| undefined
|
|
||||||
) => import('puppeteer-core/internal/puppeteer-core.js').BrowserFetcher;
|
|
||||||
```
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: ExperimentsConfiguration
|
|
||||||
---
|
|
||||||
|
|
||||||
# ExperimentsConfiguration interface
|
|
||||||
|
|
||||||
Defines experiment options for Puppeteer.
|
|
||||||
|
|
||||||
See individual properties for more information.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export interface ExperimentsConfiguration
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
| Property | Modifiers | Type | Description | Default |
|
|
||||||
| --------------------- | --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
|
|
||||||
| macArmChromiumEnabled | <code>optional</code> | boolean | <p>Require Puppeteer to download Chromium for Apple M1.</p><p>On Apple M1 devices Puppeteer by default downloads the version for Intel's processor which runs via Rosetta. It works without any problems, however, with this option, you should get more efficient resource usage (CPU and RAM) that could lead to a faster execution time.</p><p>Can be overridden by <code>PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM</code>.</p> | <code>false</code> |
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: Platform
|
|
||||||
---
|
|
||||||
|
|
||||||
# Platform type
|
|
||||||
|
|
||||||
Supported platforms.
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export type Platform = 'linux' | 'mac' | 'mac_arm' | 'win32' | 'win64';
|
|
||||||
```
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_label: PuppeteerNode.createBrowserFetcher
|
|
||||||
---
|
|
||||||
|
|
||||||
# PuppeteerNode.createBrowserFetcher() method
|
|
||||||
|
|
||||||
#### Signature:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
class PuppeteerNode {
|
|
||||||
createBrowserFetcher(
|
|
||||||
options?: Partial<BrowserFetcherOptions>
|
|
||||||
): BrowserFetcher;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| options | Partial<[BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md)> | _(Optional)_ Set of configurable options to specify the settings of the BrowserFetcher. |
|
|
||||||
|
|
||||||
**Returns:**
|
|
||||||
|
|
||||||
[BrowserFetcher](./puppeteer.browserfetcher.md)
|
|
||||||
|
|
||||||
A new BrowserFetcher instance.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
If you are using `puppeteer-core`, do not use this method. Just construct [BrowserFetcher](./puppeteer.browserfetcher.md) manually.
|
|
||||||
@ -8,11 +8,9 @@ sidebar_label: API
|
|||||||
|
|
||||||
| Class | Description |
|
| Class | Description |
|
||||||
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| [AbortError](./puppeteer.aborterror.md) | AbortError is emitted whenever certain operations are terminated due to an abort request. |
|
| [Accessibility](./puppeteer.accessibility.md) | The Accessibility class provides methods for inspecting the browser'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). |
|
||||||
| [Accessibility](./puppeteer.accessibility.md) | 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). |
|
| [Browser](./puppeteer.browser.md) | A Browser is created when Puppeteer connects to a browser instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
|
||||||
| [Browser](./puppeteer.browser.md) | 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). |
|
|
||||||
| [BrowserContext](./puppeteer.browsercontext.md) | 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. |
|
| [BrowserContext](./puppeteer.browsercontext.md) | 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. |
|
||||||
| [BrowserFetcher](./puppeteer.browserfetcher.md) | BrowserFetcher can download and manage different versions of Chromium and Firefox. |
|
|
||||||
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
|
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
|
||||||
| [Connection](./puppeteer.connection.md) | |
|
| [Connection](./puppeteer.connection.md) | |
|
||||||
| [ConsoleMessage](./puppeteer.consolemessage.md) | ConsoleMessage objects are dispatched by page via the 'console' event. |
|
| [ConsoleMessage](./puppeteer.consolemessage.md) | ConsoleMessage objects are dispatched by page via the 'console' event. |
|
||||||
@ -32,7 +30,7 @@ sidebar_label: API
|
|||||||
| [JSHandle](./puppeteer.jshandle.md) | <p>Represents a reference to a JavaScript object. Instances can be created using [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md).</p><p>Handles prevent the referenced JavaScript object from being garbage-collected unless the handle is purposely [disposed](./puppeteer.jshandle.dispose.md). JSHandles are auto-disposed when their associated frame is navigated away or the parent context gets destroyed.</p><p>Handles can be used as arguments for any evaluation function such as [Page.$eval()](./puppeteer.page._eval.md), [Page.evaluate()](./puppeteer.page.evaluate.md), and [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md). They are resolved to their referenced object.</p> |
|
| [JSHandle](./puppeteer.jshandle.md) | <p>Represents a reference to a JavaScript object. Instances can be created using [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md).</p><p>Handles prevent the referenced JavaScript object from being garbage-collected unless the handle is purposely [disposed](./puppeteer.jshandle.dispose.md). JSHandles are auto-disposed when their associated frame is navigated away or the parent context gets destroyed.</p><p>Handles can be used as arguments for any evaluation function such as [Page.$eval()](./puppeteer.page._eval.md), [Page.evaluate()](./puppeteer.page.evaluate.md), and [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md). They are resolved to their referenced object.</p> |
|
||||||
| [Keyboard](./puppeteer.keyboard.md) | Keyboard provides an api for managing a virtual keyboard. The high level api is [Keyboard.type()](./puppeteer.keyboard.type.md), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page. |
|
| [Keyboard](./puppeteer.keyboard.md) | Keyboard provides an api for managing a virtual keyboard. The high level api is [Keyboard.type()](./puppeteer.keyboard.type.md), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page. |
|
||||||
| [Mouse](./puppeteer.mouse.md) | The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport. |
|
| [Mouse](./puppeteer.mouse.md) | The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport. |
|
||||||
| [Page](./puppeteer.page.md) | <p>Page provides methods to interact with a single tab or [extension background page](https://developer.chrome.com/extensions/background_pages) in Chromium.</p><p>:::note</p><p>One Browser instance might have multiple Page instances.</p><p>:::</p> |
|
| [Page](./puppeteer.page.md) | <p>Page provides methods to interact with a single tab or [extension background page](https://developer.chrome.com/extensions/background_pages) in the browser.</p><p>:::note</p><p>One Browser instance might have multiple Page instances.</p><p>:::</p> |
|
||||||
| [ProductLauncher](./puppeteer.productlauncher.md) | Describes a launcher - a class that is able to create and launch a browser instance. |
|
| [ProductLauncher](./puppeteer.productlauncher.md) | Describes a launcher - a class that is able to create and launch a browser instance. |
|
||||||
| [ProtocolError](./puppeteer.protocolerror.md) | ProtocolError is emitted whenever there is an error from the protocol. |
|
| [ProtocolError](./puppeteer.protocolerror.md) | ProtocolError is emitted whenever there is an error from the protocol. |
|
||||||
| [Puppeteer](./puppeteer.puppeteer.md) | <p>The main Puppeteer class.</p><p>IMPORTANT: if you are using Puppeteer in a Node environment, you will get an instance of [PuppeteerNode](./puppeteer.puppeteernode.md) when you import or require <code>puppeteer</code>. That class extends <code>Puppeteer</code>, so has all the methods documented below as well as all that are defined on [PuppeteerNode](./puppeteer.puppeteernode.md).</p> |
|
| [Puppeteer](./puppeteer.puppeteer.md) | <p>The main Puppeteer class.</p><p>IMPORTANT: if you are using Puppeteer in a Node environment, you will get an instance of [PuppeteerNode](./puppeteer.puppeteernode.md) when you import or require <code>puppeteer</code>. That class extends <code>Puppeteer</code>, so has all the methods documented below as well as all that are defined on [PuppeteerNode](./puppeteer.puppeteernode.md).</p> |
|
||||||
@ -70,8 +68,6 @@ sidebar_label: API
|
|||||||
| [BoxModel](./puppeteer.boxmodel.md) | |
|
| [BoxModel](./puppeteer.boxmodel.md) | |
|
||||||
| [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) | Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. |
|
| [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) | Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. |
|
||||||
| [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | BrowserContext options. |
|
| [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | BrowserContext options. |
|
||||||
| [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | |
|
|
||||||
| [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) | |
|
|
||||||
| [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) | Launcher options that only apply to Chrome. |
|
| [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) | Launcher options that only apply to Chrome. |
|
||||||
| [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) | |
|
| [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) | |
|
||||||
| [ClickOptions](./puppeteer.clickoptions.md) | |
|
| [ClickOptions](./puppeteer.clickoptions.md) | |
|
||||||
@ -86,7 +82,6 @@ sidebar_label: API
|
|||||||
| [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. |
|
| [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. |
|
||||||
| [CustomQueryHandler](./puppeteer.customqueryhandler.md) | |
|
| [CustomQueryHandler](./puppeteer.customqueryhandler.md) | |
|
||||||
| [Device](./puppeteer.device.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) | |
|
| [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | |
|
||||||
| [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | |
|
| [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | |
|
||||||
| [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | |
|
| [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | |
|
||||||
@ -129,7 +124,6 @@ sidebar_label: API
|
|||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| [connect](./puppeteer.connect.md) | |
|
| [connect](./puppeteer.connect.md) | |
|
||||||
| [createBrowserFetcher](./puppeteer.createbrowserfetcher.md) | |
|
|
||||||
| [DEFAULT_INTERCEPT_RESOLUTION_PRIORITY](./puppeteer.default_intercept_resolution_priority.md) | The default cooperative request interception resolution priority |
|
| [DEFAULT_INTERCEPT_RESOLUTION_PRIORITY](./puppeteer.default_intercept_resolution_priority.md) | The default cooperative request interception resolution priority |
|
||||||
| [defaultArgs](./puppeteer.defaultargs.md) | |
|
| [defaultArgs](./puppeteer.defaultargs.md) | |
|
||||||
| [devices](./puppeteer.devices.md) | |
|
| [devices](./puppeteer.devices.md) | |
|
||||||
@ -157,6 +151,7 @@ sidebar_label: API
|
|||||||
| [EvaluateFunc](./puppeteer.evaluatefunc.md) | |
|
| [EvaluateFunc](./puppeteer.evaluatefunc.md) | |
|
||||||
| [EvaluateFuncWith](./puppeteer.evaluatefuncwith.md) | |
|
| [EvaluateFuncWith](./puppeteer.evaluatefuncwith.md) | |
|
||||||
| [EventType](./puppeteer.eventtype.md) | |
|
| [EventType](./puppeteer.eventtype.md) | |
|
||||||
|
| [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | <p>Defines experiment options for Puppeteer.</p><p>See individual properties for more information.</p> |
|
||||||
| [FlattenHandle](./puppeteer.flattenhandle.md) | |
|
| [FlattenHandle](./puppeteer.flattenhandle.md) | |
|
||||||
| [HandleFor](./puppeteer.handlefor.md) | |
|
| [HandleFor](./puppeteer.handlefor.md) | |
|
||||||
| [HandleOr](./puppeteer.handleor.md) | |
|
| [HandleOr](./puppeteer.handleor.md) | |
|
||||||
@ -169,7 +164,6 @@ sidebar_label: API
|
|||||||
| [NodeFor](./puppeteer.nodefor.md) | |
|
| [NodeFor](./puppeteer.nodefor.md) | |
|
||||||
| [PaperFormat](./puppeteer.paperformat.md) | All the valid paper format types when printing a PDF. |
|
| [PaperFormat](./puppeteer.paperformat.md) | All the valid paper format types when printing a PDF. |
|
||||||
| [Permission](./puppeteer.permission.md) | |
|
| [Permission](./puppeteer.permission.md) | |
|
||||||
| [Platform](./puppeteer.platform.md) | Supported platforms. |
|
|
||||||
| [Product](./puppeteer.product.md) | Supported products. |
|
| [Product](./puppeteer.product.md) | Supported products. |
|
||||||
| [ProtocolLifeCycleEvent](./puppeteer.protocollifecycleevent.md) | |
|
| [ProtocolLifeCycleEvent](./puppeteer.protocollifecycleevent.md) | |
|
||||||
| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) | |
|
| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) | |
|
||||||
@ -4,7 +4,7 @@ sidebar_label: Accessibility
|
|||||||
|
|
||||||
# Accessibility class
|
# Accessibility class
|
||||||
|
|
||||||
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).
|
The Accessibility class provides methods for inspecting the browser'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:
|
||||||
|
|
||||||
@ -28,7 +28,7 @@ An AXNode object representing the snapshot.
|
|||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
**NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
|
**NOTE** The Chrome accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
|
||||||
|
|
||||||
## Example 1
|
## Example 1
|
||||||
|
|
||||||
@ -4,7 +4,7 @@ sidebar_label: Browser.close
|
|||||||
|
|
||||||
# Browser.close() method
|
# Browser.close() method
|
||||||
|
|
||||||
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.
|
Closes the browser 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:
|
||||||
|
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
sidebar_label: Browser.disconnect
|
||||||
|
---
|
||||||
|
|
||||||
|
# Browser.disconnect() method
|
||||||
|
|
||||||
|
Disconnects Puppeteer from the browser, but leaves the browser process running. After calling `disconnect`, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore.
|
||||||
|
|
||||||
|
#### Signature:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class Browser {
|
||||||
|
disconnect(): void;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Returns:**
|
||||||
|
|
||||||
|
void
|
||||||
@ -4,7 +4,7 @@ sidebar_label: Browser
|
|||||||
|
|
||||||
# Browser class
|
# Browser class
|
||||||
|
|
||||||
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).
|
A Browser is created when Puppeteer connects to a browser instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).
|
||||||
|
|
||||||
#### Signature:
|
#### Signature:
|
||||||
|
|
||||||
@ -44,34 +44,34 @@ import puppeteer from 'puppeteer';
|
|||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const browser = await puppeteer.launch();
|
const browser = await puppeteer.launch();
|
||||||
// Store the endpoint to be able to reconnect to Chromium
|
// Store the endpoint to be able to reconnect to the browser.
|
||||||
const browserWSEndpoint = browser.wsEndpoint();
|
const browserWSEndpoint = browser.wsEndpoint();
|
||||||
// Disconnect puppeteer from Chromium
|
// Disconnect puppeteer from the browser.
|
||||||
browser.disconnect();
|
browser.disconnect();
|
||||||
|
|
||||||
// Use the endpoint to reestablish a connection
|
// Use the endpoint to reestablish a connection
|
||||||
const browser2 = await puppeteer.connect({browserWSEndpoint});
|
const browser2 = await puppeteer.connect({browserWSEndpoint});
|
||||||
// Close Chromium
|
// Close the browser.
|
||||||
await browser2.close();
|
await browser2.close();
|
||||||
})();
|
})();
|
||||||
```
|
```
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
| Method | Modifiers | Description |
|
| Method | Modifiers | Description |
|
||||||
| ---------------------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). |
|
| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). |
|
||||||
| [close()](./puppeteer.browser.close.md) | | 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. |
|
| [close()](./puppeteer.browser.close.md) | | Closes the browser 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. |
|
||||||
| [createIncognitoBrowserContext(options)](./puppeteer.browser.createincognitobrowsercontext.md) | | Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. |
|
| [createIncognitoBrowserContext(options)](./puppeteer.browser.createincognitobrowsercontext.md) | | Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. |
|
||||||
| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | Returns the default browser context. The default browser context cannot be closed. |
|
| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | Returns the default browser context. The default browser context cannot be closed. |
|
||||||
| [disconnect()](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling <code>disconnect</code>, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. |
|
| [disconnect()](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from the browser, but leaves the browser process running. After calling <code>disconnect</code>, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. |
|
||||||
| [isConnected()](./puppeteer.browser.isconnected.md) | | Indicates that the browser is connected. |
|
| [isConnected()](./puppeteer.browser.isconnected.md) | | Indicates that the browser is connected. |
|
||||||
| [newPage()](./puppeteer.browser.newpage.md) | | Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context. |
|
| [newPage()](./puppeteer.browser.newpage.md) | | Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context. |
|
||||||
| [pages()](./puppeteer.browser.pages.md) | | An array of all open pages inside the Browser. |
|
| [pages()](./puppeteer.browser.pages.md) | | An array of all open pages inside the Browser. |
|
||||||
| [process()](./puppeteer.browser.process.md) | | The spawned browser process. Returns <code>null</code> if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
|
| [process()](./puppeteer.browser.process.md) | | The spawned browser process. Returns <code>null</code> if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
|
||||||
| [target()](./puppeteer.browser.target.md) | | The target associated with the browser. |
|
| [target()](./puppeteer.browser.target.md) | | The target associated with the browser. |
|
||||||
| [targets()](./puppeteer.browser.targets.md) | | All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. |
|
| [targets()](./puppeteer.browser.targets.md) | | All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. |
|
||||||
| [userAgent()](./puppeteer.browser.useragent.md) | | The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md). |
|
| [userAgent()](./puppeteer.browser.useragent.md) | | The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md). |
|
||||||
| [version()](./puppeteer.browser.version.md) | | A string representing the browser name and version. |
|
| [version()](./puppeteer.browser.version.md) | | A string representing the browser name and version. |
|
||||||
| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | Searches for a target in all browser contexts. |
|
| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | Searches for a target in all browser contexts. |
|
||||||
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
|
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
|
||||||
@ -20,6 +20,6 @@ Promise<string>
|
|||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`. For non-headless, this is similar to `Chrome/61.0.3153.0`.
|
For headless browser, this is similar to `HeadlessChrome/61.0.3153.0`. For non-headless, this is similar to `Chrome/61.0.3153.0`.
|
||||||
|
|
||||||
The format of browser.version() might change with future releases of Chromium.
|
The format of browser.version() might change with future releases of browsers.
|
||||||
@ -16,7 +16,7 @@ export declare const enum BrowserEmittedEvents
|
|||||||
|
|
||||||
| Member | Value | Description |
|
| Member | Value | Description |
|
||||||
| --------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| Disconnected | <code>"disconnected"</code> | <p>Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:</p><p>- Chromium is closed or crashed</p><p>- The [browser.disconnect](./puppeteer.browser.disconnect.md) method was called.</p> |
|
| Disconnected | <code>"disconnected"</code> | <p>Emitted when Puppeteer gets disconnected from the browser instance. This might happen because of one of the following:</p><p>- browser is closed or crashed</p><p>- The [browser.disconnect](./puppeteer.browser.disconnect.md) method was called.</p> |
|
||||||
| TargetChanged | <code>"targetchanged"</code> | Emitted when the url of a target changes. Contains a [Target](./puppeteer.target.md) instance. |
|
| TargetChanged | <code>"targetchanged"</code> | Emitted when the url of a target changes. Contains a [Target](./puppeteer.target.md) instance. |
|
||||||
| TargetCreated | <code>"targetcreated"</code> | <p>Emitted when a target is created, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browser.newPage](./puppeteer.browser.newpage.md)</p><p>Contains a [Target](./puppeteer.target.md) instance.</p> |
|
| TargetCreated | <code>"targetcreated"</code> | <p>Emitted when a target is created, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browser.newPage](./puppeteer.browser.newpage.md)</p><p>Contains a [Target](./puppeteer.target.md) instance.</p> |
|
||||||
| TargetDestroyed | <code>"targetdestroyed"</code> | Emitted when a target is destroyed, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. |
|
| TargetDestroyed | <code>"targetdestroyed"</code> | Emitted when a target is destroyed, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. |
|
||||||
@ -21,7 +21,7 @@ export interface Configuration
|
|||||||
| browserRevision | <code>optional</code> | string | <p>Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
|
| browserRevision | <code>optional</code> | string | <p>Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
|
||||||
| cacheDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
|
| cacheDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
|
||||||
| defaultProduct | <code>optional</code> | [Product](./puppeteer.product.md) | <p>Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>chrome</code> |
|
| defaultProduct | <code>optional</code> | [Product](./puppeteer.product.md) | <p>Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>chrome</code> |
|
||||||
| downloadHost | <code>optional</code> | string | <p>Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
|
| downloadHost | <code>optional</code> | string | <p>Specifies the URL prefix that is used to download the browser.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
|
||||||
| downloadPath | <code>optional</code> | string | <p>Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code><cache>/<product></code> where <code><cache></code> is Puppeteer's cache directory and <code><product></code> is the name of the browser. |
|
| downloadPath | <code>optional</code> | string | <p>Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code><cache>/<product></code> where <code><cache></code> is Puppeteer's cache directory and <code><product></code> is the name of the browser. |
|
||||||
| executablePath | <code>optional</code> | string | <p>Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | **Auto-computed.** |
|
| executablePath | <code>optional</code> | string | <p>Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | **Auto-computed.** |
|
||||||
| experiments | <code>optional</code> | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | |
|
| experiments | <code>optional</code> | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user