diff --git a/.release-please-manifest.json b/.release-please-manifest.json index c918d9438ae..1237fb11dd9 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,6 +1,6 @@ { - "packages/puppeteer": "21.9.0", - "packages/puppeteer-core": "21.9.0", + "packages/puppeteer": "21.10.0", + "packages/puppeteer-core": "21.10.0", "packages/testserver": "0.6.0", "packages/ng-schematics": "0.5.6", "packages/browsers": "1.9.1" diff --git a/package-lock.json b/package-lock.json index fc15130a871..7990aece1ce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11367,13 +11367,13 @@ } }, "packages/puppeteer": { - "version": "21.9.0", + "version": "21.10.0", "hasInstallScript": true, "license": "Apache-2.0", "dependencies": { "@puppeteer/browsers": "1.9.1", "cosmiconfig": "9.0.0", - "puppeteer-core": "21.9.0" + "puppeteer-core": "21.10.0" }, "bin": { "puppeteer": "lib/esm/puppeteer/node/cli.js" @@ -11386,7 +11386,7 @@ } }, "packages/puppeteer-core": { - "version": "21.9.0", + "version": "21.10.0", "license": "Apache-2.0", "dependencies": { "@puppeteer/browsers": "1.9.1", diff --git a/packages/puppeteer-core/CHANGELOG.md b/packages/puppeteer-core/CHANGELOG.md index d09ad5acb8d..341d706fb4f 100644 --- a/packages/puppeteer-core/CHANGELOG.md +++ b/packages/puppeteer-core/CHANGELOG.md @@ -20,6 +20,19 @@ All notable changes to this project will be documented in this file. See [standa * dependencies * @puppeteer/browsers bumped from 1.5.1 to 1.6.0 +## [21.10.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v21.9.0...puppeteer-core-v21.10.0) (2024-01-29) + + +### Features + +* add experimental browser.debugInfo ([#11748](https://github.com/puppeteer/puppeteer/issues/11748)) ([f88e1da](https://github.com/puppeteer/puppeteer/commit/f88e1da6385bc72e9ffde8514c28e4a0ff9e396a)) +* download chrome-headless-shell by default and use it for the old headless mode ([#11754](https://github.com/puppeteer/puppeteer/issues/11754)) ([ce894a2](https://github.com/puppeteer/puppeteer/commit/ce894a2ffce4bc44bd11f12d1f0543e003a97e02)) + + +### Bug Fixes + +* set viewport for element screenshots ([#11772](https://github.com/puppeteer/puppeteer/issues/11772)) ([9cd6673](https://github.com/puppeteer/puppeteer/commit/9cd66731d148afff9c2f873c1383fbe367cc5fb2)) + ## [21.9.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v21.8.0...puppeteer-core-v21.9.0) (2024-01-24) diff --git a/packages/puppeteer-core/package.json b/packages/puppeteer-core/package.json index 1aef9b695bb..2f1943bd2f9 100644 --- a/packages/puppeteer-core/package.json +++ b/packages/puppeteer-core/package.json @@ -1,6 +1,6 @@ { "name": "puppeteer-core", - "version": "21.9.0", + "version": "21.10.0", "description": "A high-level API to control headless Chrome over the DevTools Protocol", "keywords": [ "puppeteer", diff --git a/packages/puppeteer/CHANGELOG.md b/packages/puppeteer/CHANGELOG.md index 87621d9e0dd..c3d834c5f51 100644 --- a/packages/puppeteer/CHANGELOG.md +++ b/packages/puppeteer/CHANGELOG.md @@ -29,6 +29,20 @@ All notable changes to this project will be documented in this file. See [standa * puppeteer-core bumped from 21.0.2 to 21.0.3 * @puppeteer/browsers bumped from 1.5.1 to 1.6.0 +## [21.10.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v21.9.0...puppeteer-v21.10.0) (2024-01-29) + + +### Features + +* download chrome-headless-shell by default and use it for the old headless mode ([#11754](https://github.com/puppeteer/puppeteer/issues/11754)) ([ce894a2](https://github.com/puppeteer/puppeteer/commit/ce894a2ffce4bc44bd11f12d1f0543e003a97e02)) + + +### Dependencies + +* The following workspace dependencies were updated + * dependencies + * puppeteer-core bumped from 21.9.0 to 21.10.0 + ## [21.9.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v21.8.0...puppeteer-v21.9.0) (2024-01-24) diff --git a/packages/puppeteer/package.json b/packages/puppeteer/package.json index ce976bf0eb6..0419e4b4599 100644 --- a/packages/puppeteer/package.json +++ b/packages/puppeteer/package.json @@ -1,6 +1,6 @@ { "name": "puppeteer", - "version": "21.9.0", + "version": "21.10.0", "description": "A high-level API to control headless Chrome over the DevTools Protocol", "keywords": [ "puppeteer", @@ -124,7 +124,7 @@ "license": "Apache-2.0", "dependencies": { "cosmiconfig": "9.0.0", - "puppeteer-core": "21.9.0", + "puppeteer-core": "21.10.0", "@puppeteer/browsers": "1.9.1" }, "devDependencies": { diff --git a/website/versioned_docs/version-21.9.0/api/index.md b/website/versioned_docs/version-21.10.0/api/index.md similarity index 98% rename from website/versioned_docs/version-21.9.0/api/index.md rename to website/versioned_docs/version-21.10.0/api/index.md index 9899ecbed13..9e8b2a1c2bc 100644 --- a/website/versioned_docs/version-21.9.0/api/index.md +++ b/website/versioned_docs/version-21.10.0/api/index.md @@ -58,12 +58,12 @@ sidebar_label: API ## Functions -| Function | Description | -| --------------------------------------------------------------------------- | ----------- | -| [clearCustomQueryHandlers](./puppeteer.clearcustomqueryhandlers.md) | | -| [customQueryHandlerNames](./puppeteer.customqueryhandlernames.md) | | -| [registerCustomQueryHandler](./puppeteer.registercustomqueryhandler.md) | | -| [unregisterCustomQueryHandler](./puppeteer.unregistercustomqueryhandler.md) | | +| Function | Description | +| -------------------------------------------------------------------------------------- | ----------- | +| [clearCustomQueryHandlers()](./puppeteer.clearcustomqueryhandlers.md) | | +| [customQueryHandlerNames()](./puppeteer.customqueryhandlernames.md) | | +| [registerCustomQueryHandler(name, handler)](./puppeteer.registercustomqueryhandler.md) | | +| [unregisterCustomQueryHandler(name)](./puppeteer.unregistercustomqueryhandler.md) | | ## Interfaces @@ -91,6 +91,7 @@ sidebar_label: API | [Credentials](./puppeteer.credentials.md) | | | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. | | [CustomQueryHandler](./puppeteer.customqueryhandler.md) | | +| [DebugInfo](./puppeteer.debuginfo.md) | | | [Device](./puppeteer.device.md) | | | [ElementScreenshotOptions](./puppeteer.elementscreenshotoptions.md) | | | [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | | @@ -134,6 +135,7 @@ sidebar_label: API | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | | [TracingOptions](./puppeteer.tracingoptions.md) | | | [Viewport](./puppeteer.viewport.md) | | +| [WaitForNetworkIdleOptions](./puppeteer.waitfornetworkidleoptions.md) | | | [WaitForOptions](./puppeteer.waitforoptions.md) | | | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | | | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | @@ -170,6 +172,7 @@ sidebar_label: API | [ActionResult](./puppeteer.actionresult.md) | | | [Awaitable](./puppeteer.awaitable.md) | | | [AwaitableIterable](./puppeteer.awaitableiterable.md) | | +| [AwaitablePredicate](./puppeteer.awaitablepredicate.md) | | | [AwaitedLocator](./puppeteer.awaitedlocator.md) | | | [CDPEvents](./puppeteer.cdpevents.md) | | | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.accessibility.md b/website/versioned_docs/version-21.10.0/api/puppeteer.accessibility.md similarity index 67% rename from website/versioned_docs/version-21.9.0/api/puppeteer.accessibility.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.accessibility.md index 9ed989584c6..542c197cc5f 100644 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.accessibility.md +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.accessibility.md @@ -24,6 +24,6 @@ The constructor for this class is marked as internal. Third-party code should no ## Methods -| Method | Modifiers | Description | -| ------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | -| [snapshot](./puppeteer.accessibility.snapshot.md) | | Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | +| Method | Modifiers | Description | +| ---------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | +| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.accessibility.snapshot.md b/website/versioned_docs/version-21.10.0/api/puppeteer.accessibility.snapshot.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.accessibility.snapshot.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.accessibility.snapshot.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.actionoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.actionoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.actionoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.actionoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.actionresult.md b/website/versioned_docs/version-21.10.0/api/puppeteer.actionresult.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.actionresult.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.actionresult.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.autofilldata.md b/website/versioned_docs/version-21.10.0/api/puppeteer.autofilldata.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.autofilldata.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.autofilldata.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.awaitable.md b/website/versioned_docs/version-21.10.0/api/puppeteer.awaitable.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.awaitable.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.awaitable.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.awaitableiterable.md b/website/versioned_docs/version-21.10.0/api/puppeteer.awaitableiterable.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.awaitableiterable.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.awaitableiterable.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.awaitablepredicate.md b/website/versioned_docs/version-21.10.0/api/puppeteer.awaitablepredicate.md new file mode 100644 index 00000000000..62c02624303 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.awaitablepredicate.md @@ -0,0 +1,13 @@ +--- +sidebar_label: AwaitablePredicate +--- + +# AwaitablePredicate type + +#### Signature: + +```typescript +export type AwaitablePredicate = (value: T) => Awaitable; +``` + +**References:** [Awaitable](./puppeteer.awaitable.md) diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.awaitedlocator.md b/website/versioned_docs/version-21.10.0/api/puppeteer.awaitedlocator.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.awaitedlocator.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.awaitedlocator.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.boundingbox.md b/website/versioned_docs/version-21.10.0/api/puppeteer.boundingbox.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.boundingbox.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.boundingbox.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.boxmodel.md b/website/versioned_docs/version-21.10.0/api/puppeteer.boxmodel.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.boxmodel.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.boxmodel.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.browsercontexts.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.browsercontexts.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.browsercontexts.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.browsercontexts.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.close.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.close.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.close.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.close.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.createincognitobrowsercontext.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.createincognitobrowsercontext.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.createincognitobrowsercontext.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.createincognitobrowsercontext.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.defaultbrowsercontext.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.defaultbrowsercontext.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.defaultbrowsercontext.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.defaultbrowsercontext.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.disconnect.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.disconnect.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.disconnect.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.disconnect.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.isconnected.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.isconnected.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.isconnected.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.isconnected.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.md similarity index 51% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.md index f7191c54892..e46e7a05a18 100644 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.md +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.md @@ -56,26 +56,27 @@ await browser2.close(); ## Properties -| Property | Modifiers | Type | Description | -| --------- | --------------------- | ------- | ------------------------------------------------------------------------- | -| connected | readonly | boolean | Whether Puppeteer is connected to this [browser](./puppeteer.browser.md). | +| Property | Modifiers | Type | Description | +| --------- | --------------------- | ------------------------------------- | ------------------------------------------------------------------------- | +| connected | readonly | boolean | Whether Puppeteer is connected to this [browser](./puppeteer.browser.md). | +| debugInfo | readonly | [DebugInfo](./puppeteer.debuginfo.md) | Get debug information from Puppeteer. | ## Methods -| Method | Modifiers | Description | -| ------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [browserContexts](./puppeteer.browser.browsercontexts.md) | |

Gets a list of open [browser contexts](./puppeteer.browsercontext.md).

In a newly-created [browser](./puppeteer.browser.md), this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md).

| -| [close](./puppeteer.browser.close.md) | | Closes this [browser](./puppeteer.browser.md) and all associated [pages](./puppeteer.page.md). | -| [createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) | |

Creates a new incognito [browser context](./puppeteer.browsercontext.md).

This won't share cookies/cache with other [browser contexts](./puppeteer.browsercontext.md).

| -| [defaultBrowserContext](./puppeteer.browser.defaultbrowsercontext.md) | | Gets the default [browser context](./puppeteer.browsercontext.md). | -| [disconnect](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from this [browser](./puppeteer.browser.md), but leaves the process running. | -| [isConnected](./puppeteer.browser.isconnected.md) | | Whether Puppeteer is connected to this [browser](./puppeteer.browser.md). | -| [newPage](./puppeteer.browser.newpage.md) | | Creates a new [page](./puppeteer.page.md) in the [default browser context](./puppeteer.browser.defaultbrowsercontext.md). | -| [pages](./puppeteer.browser.pages.md) | |

Gets a list of all open [pages](./puppeteer.page.md) inside this [Browser](./puppeteer.browser.md).

If there ar multiple [browser contexts](./puppeteer.browsercontext.md), this returns all [pages](./puppeteer.page.md) in all [browser contexts](./puppeteer.browsercontext.md).

| -| [process](./puppeteer.browser.process.md) | | Gets the associated [ChildProcess](https://nodejs.org/api/child_process.html#class-childprocess). | -| [target](./puppeteer.browser.target.md) | | Gets the [target](./puppeteer.target.md) associated with the [default browser context](./puppeteer.browser.defaultbrowsercontext.md)). | -| [targets](./puppeteer.browser.targets.md) | |

Gets all active [targets](./puppeteer.target.md).

In case of multiple [browser contexts](./puppeteer.browsercontext.md), this returns all [targets](./puppeteer.target.md) in all [browser contexts](./puppeteer.browsercontext.md).

| -| [userAgent](./puppeteer.browser.useragent.md) | |

Gets this [browser's](./puppeteer.browser.md) original user agent.

[Pages](./puppeteer.page.md) can override the user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).

| -| [version](./puppeteer.browser.version.md) | |

Gets a string representing this [browser's](./puppeteer.browser.md) name and version.

For headless browser, this is similar to "HeadlessChrome/61.0.3153.0". For non-headless or new-headless, this is similar to "Chrome/61.0.3153.0". For Firefox, it is similar to "Firefox/116.0a1".

The format of [Browser.version()](./puppeteer.browser.version.md) might change with future releases of browsers.

| -| [waitForTarget](./puppeteer.browser.waitfortarget.md) | |

Waits until a [target](./puppeteer.target.md) matching the given predicate appears and returns it.

This will look all open [browser contexts](./puppeteer.browsercontext.md).

| -| [wsEndpoint](./puppeteer.browser.wsendpoint.md) | |

Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).

This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).

You can find the debugger URL (webSocketDebuggerUrl) from http://HOST:PORT/json/version.

See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.

| +| Method | Modifiers | Description | +| ---------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [browserContexts()](./puppeteer.browser.browsercontexts.md) | |

Gets a list of open [browser contexts](./puppeteer.browsercontext.md).

In a newly-created [browser](./puppeteer.browser.md), this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md).

| +| [close()](./puppeteer.browser.close.md) | | Closes this [browser](./puppeteer.browser.md) and all associated [pages](./puppeteer.page.md). | +| [createIncognitoBrowserContext(options)](./puppeteer.browser.createincognitobrowsercontext.md) | |

Creates a new incognito [browser context](./puppeteer.browsercontext.md).

This won't share cookies/cache with other [browser contexts](./puppeteer.browsercontext.md).

| +| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | Gets the default [browser context](./puppeteer.browsercontext.md). | +| [disconnect()](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from this [browser](./puppeteer.browser.md), but leaves the process running. | +| [isConnected()](./puppeteer.browser.isconnected.md) | | Whether Puppeteer is connected to this [browser](./puppeteer.browser.md). | +| [newPage()](./puppeteer.browser.newpage.md) | | Creates a new [page](./puppeteer.page.md) in the [default browser context](./puppeteer.browser.defaultbrowsercontext.md). | +| [pages()](./puppeteer.browser.pages.md) | |

Gets a list of all open [pages](./puppeteer.page.md) inside this [Browser](./puppeteer.browser.md).

If there ar multiple [browser contexts](./puppeteer.browsercontext.md), this returns all [pages](./puppeteer.page.md) in all [browser contexts](./puppeteer.browsercontext.md).

| +| [process()](./puppeteer.browser.process.md) | | Gets the associated [ChildProcess](https://nodejs.org/api/child_process.html#class-childprocess). | +| [target()](./puppeteer.browser.target.md) | | Gets the [target](./puppeteer.target.md) associated with the [default browser context](./puppeteer.browser.defaultbrowsercontext.md)). | +| [targets()](./puppeteer.browser.targets.md) | |

Gets all active [targets](./puppeteer.target.md).

In case of multiple [browser contexts](./puppeteer.browsercontext.md), this returns all [targets](./puppeteer.target.md) in all [browser contexts](./puppeteer.browsercontext.md).

| +| [userAgent()](./puppeteer.browser.useragent.md) | |

Gets this [browser's](./puppeteer.browser.md) original user agent.

[Pages](./puppeteer.page.md) can override the user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).

| +| [version()](./puppeteer.browser.version.md) | |

Gets a string representing this [browser's](./puppeteer.browser.md) name and version.

For headless browser, this is similar to "HeadlessChrome/61.0.3153.0". For non-headless or new-headless, this is similar to "Chrome/61.0.3153.0". For Firefox, it is similar to "Firefox/116.0a1".

The format of [Browser.version()](./puppeteer.browser.version.md) might change with future releases of browsers.

| +| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | |

Waits until a [target](./puppeteer.target.md) matching the given predicate appears and returns it.

This will look all open [browser contexts](./puppeteer.browsercontext.md).

| +| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | |

Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).

This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).

You can find the debugger URL (webSocketDebuggerUrl) from http://HOST:PORT/json/version.

See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.

| diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.newpage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.newpage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.newpage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.newpage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.pages.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.pages.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.pages.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.pages.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.process.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.process.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.process.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.process.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.target.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.target.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.target.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.target.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.targets.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.targets.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.targets.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.targets.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.useragent.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.useragent.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.useragent.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.useragent.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.version.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.version.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.version.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.version.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.waitfortarget.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.waitfortarget.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.waitfortarget.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.waitfortarget.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browser.wsendpoint.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browser.wsendpoint.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browser.wsendpoint.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browser.wsendpoint.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browserconnectoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browserconnectoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browserconnectoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browserconnectoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.browser.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.browser.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.browser.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.browser.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.clearpermissionoverrides.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.clearpermissionoverrides.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.clearpermissionoverrides.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.clearpermissionoverrides.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.close.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.close.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.close.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.close.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.isincognito.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.isincognito.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.isincognito.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.isincognito.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.md new file mode 100644 index 00000000000..87c6540f5dc --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.md @@ -0,0 +1,61 @@ +--- +sidebar_label: BrowserContext +--- + +# BrowserContext class + +[BrowserContext](./puppeteer.browsercontext.md) represents individual sessions within a [browser](./puppeteer.browser.md). + +When a [browser](./puppeteer.browser.md) is launched, it has a single [browser context](./puppeteer.browsercontext.md) by default. Others can be created using [Browser.createIncognitoBrowserContext()](./puppeteer.browser.createincognitobrowsercontext.md). + +[BrowserContext](./puppeteer.browsercontext.md) [emits](./puppeteer.eventemitter.md) various events which are documented in the [BrowserContextEvent](./puppeteer.browsercontextevent.md) enum. + +If a [page](./puppeteer.page.md) opens another [page](./puppeteer.page.md), e.g. using `window.open`, the popup will belong to the parent [page's browser context](./puppeteer.page.browsercontext.md). + +#### Signature: + +```typescript +export declare abstract class BrowserContext extends EventEmitter +``` + +**Extends:** [EventEmitter](./puppeteer.eventemitter.md)<[BrowserContextEvents](./puppeteer.browsercontextevents.md)> + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserContext` class. + +## Example + +Creating an incognito [browser context](./puppeteer.browsercontext.md): + +```ts +// Create a new incognito browser context +const context = await browser.createIncognitoBrowserContext(); +// Create a new page inside context. +const page = await context.newPage(); +// ... do stuff with page ... +await page.goto('https://example.com'); +// Dispose context once it's no longer needed. +await context.close(); +``` + +## Properties + +| Property | Modifiers | Type | Description | +| -------- | --------------------- | ------------------- | ------------------------------------------------------------------------ | +| closed | readonly | boolean | Whether this [browser context](./puppeteer.browsercontext.md) is closed. | +| id | readonly | string \| undefined | Identifier for this [browser context](./puppeteer.browsercontext.md). | + +## Methods + +| Method | Modifiers | Description | +| --------------------------------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [browser()](./puppeteer.browsercontext.browser.md) | | Gets the [browser](./puppeteer.browser.md) associated with this [browser context](./puppeteer.browsercontext.md). | +| [clearPermissionOverrides()](./puppeteer.browsercontext.clearpermissionoverrides.md) | | Clears all permission overrides for this [browser context](./puppeteer.browsercontext.md). | +| [close()](./puppeteer.browsercontext.close.md) | | Closes this [browser context](./puppeteer.browsercontext.md) and all associated [pages](./puppeteer.page.md). | +| [isIncognito()](./puppeteer.browsercontext.isincognito.md) | |

Whether this [browser context](./puppeteer.browsercontext.md) is incognito.

The [default browser context](./puppeteer.browser.defaultbrowsercontext.md) is the only non-incognito browser context.

| +| [newPage()](./puppeteer.browsercontext.newpage.md) | | Creates a new [page](./puppeteer.page.md) in this [browser context](./puppeteer.browsercontext.md). | +| [overridePermissions(origin, permissions)](./puppeteer.browsercontext.overridepermissions.md) | | Grants this [browser context](./puppeteer.browsercontext.md) the given permissions within the given origin. | +| [pages()](./puppeteer.browsercontext.pages.md) | | Gets a list of all open [pages](./puppeteer.page.md) inside this [browser context](./puppeteer.browsercontext.md). | +| [targets()](./puppeteer.browsercontext.targets.md) | | Gets all active [targets](./puppeteer.target.md) inside this [browser context](./puppeteer.browsercontext.md). | +| [waitForTarget(predicate, options)](./puppeteer.browsercontext.waitfortarget.md) | |

Waits until a [target](./puppeteer.target.md) matching the given predicate appears and returns it.

This will look all open [browser contexts](./puppeteer.browsercontext.md).

| diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.newpage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.newpage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.newpage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.newpage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.overridepermissions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.overridepermissions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.overridepermissions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.overridepermissions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.pages.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.pages.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.pages.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.pages.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.targets.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.targets.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.targets.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.targets.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.waitfortarget.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.waitfortarget.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontext.waitfortarget.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontext.waitfortarget.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextevent.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextevent.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextevent.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextevent.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextevents.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextevents.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextevents.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextevents.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browsercontextoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browsercontextoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browserevent.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browserevent.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browserevent.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browserevent.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browserevents.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browserevents.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browserevents.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browserevents.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.browserlaunchargumentoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.browserlaunchargumentoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.browserlaunchargumentoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.browserlaunchargumentoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpevents.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpevents.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpevents.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpevents.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.connection.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.connection.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.connection.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.connection.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.detach.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.detach.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.detach.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.detach.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.id.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.id.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.id.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.id.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.md similarity index 62% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.md index b5b9a4f24eb..203f3a544f8 100644 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.md +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.md @@ -39,9 +39,9 @@ await client.send('Animation.setPlaybackRate', { ## Methods -| Method | Modifiers | Description | -| -------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [connection](./puppeteer.cdpsession.connection.md) | | | -| [detach](./puppeteer.cdpsession.detach.md) | | Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. | -| [id](./puppeteer.cdpsession.id.md) | | Returns the session's id. | -| [send](./puppeteer.cdpsession.send.md) | | | +| Method | Modifiers | Description | +| --------------------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| [connection()](./puppeteer.cdpsession.connection.md) | | | +| [detach()](./puppeteer.cdpsession.detach.md) | | Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. | +| [id()](./puppeteer.cdpsession.id.md) | | Returns the session's id. | +| [send(method, params, options)](./puppeteer.cdpsession.send.md) | | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.send.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.send.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsession.send.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsession.send.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.sessionattached.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.sessionattached.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.sessionattached.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.sessionattached.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.sessiondetached.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.sessiondetached.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevent.sessiondetached.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevent.sessiondetached.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevents.md b/website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevents.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.cdpsessionevents.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.cdpsessionevents.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.chromereleasechannel.md b/website/versioned_docs/version-21.10.0/api/puppeteer.chromereleasechannel.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.chromereleasechannel.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.chromereleasechannel.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.clearcustomqueryhandlers.md b/website/versioned_docs/version-21.10.0/api/puppeteer.clearcustomqueryhandlers.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.clearcustomqueryhandlers.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.clearcustomqueryhandlers.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.clickoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.clickoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.clickoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.clickoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commandoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commandoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commandoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commandoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.addlistener.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.addlistener.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.addlistener.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.addlistener.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.emit.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.emit.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.emit.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.emit.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.listenercount.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.listenercount.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.listenercount.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.listenercount.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.md new file mode 100644 index 00000000000..d117efeb4be --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.md @@ -0,0 +1,24 @@ +--- +sidebar_label: CommonEventEmitter +--- + +# CommonEventEmitter interface + +#### Signature: + +```typescript +export interface CommonEventEmitter> +``` + +## Methods + +| Method | Description | +| --------------------------------------------------------------------------------- | ----------- | +| [addListener(type, handler)](./puppeteer.commoneventemitter.addlistener.md) | | +| [emit(type, event)](./puppeteer.commoneventemitter.emit.md) | | +| [listenerCount(event)](./puppeteer.commoneventemitter.listenercount.md) | | +| [off(type, handler)](./puppeteer.commoneventemitter.off.md) | | +| [on(type, handler)](./puppeteer.commoneventemitter.on.md) | | +| [once(type, handler)](./puppeteer.commoneventemitter.once.md) | | +| [removeAllListeners(event)](./puppeteer.commoneventemitter.removealllisteners.md) | | +| [removeListener(type, handler)](./puppeteer.commoneventemitter.removelistener.md) | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.off.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.off.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.off.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.off.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.on.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.on.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.on.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.on.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.once.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.once.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.once.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.once.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.removealllisteners.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.removealllisteners.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.removealllisteners.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.removealllisteners.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.removelistener.md b/website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.removelistener.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.commoneventemitter.removelistener.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.commoneventemitter.removelistener.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.configuration.md b/website/versioned_docs/version-21.10.0/api/puppeteer.configuration.md new file mode 100644 index 00000000000..8f80db88516 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.configuration.md @@ -0,0 +1,32 @@ +--- +sidebar_label: Configuration +--- + +# Configuration interface + +Defines options to configure Puppeteer's behavior during installation and runtime. + +See individual properties for more information. + +#### Signature: + +```typescript +export interface Configuration +``` + +## Properties + +| Property | Modifiers | Type | Description | Default | +| ------------------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| browserRevision | optional | string |

Specifies a certain version of the browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_BROWSER_REVISION.

See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.

| A compatible-revision of the browser. | +| cacheDirectory | optional | string |

Defines the directory to be used by Puppeteer for caching.

Can be overridden by PUPPETEER_CACHE_DIR.

| path.join(os.homedir(), '.cache', 'puppeteer') | +| defaultProduct | optional | [Product](./puppeteer.product.md) |

Specifies which browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_PRODUCT.

| chrome | +| downloadBaseUrl | optional | string |

Specifies the URL prefix that is used to download the browser.

Can be overridden by PUPPETEER_DOWNLOAD_BASE_URL.

| Either https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. | +| downloadPath | optional | string |

Specifies the path for the downloads folder.

Can be overridden by PUPPETEER_DOWNLOAD_PATH.

| <cacheDirectory> | +| executablePath | optional | string |

Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).

Can be overridden by PUPPETEER_EXECUTABLE_PATH.

| **Auto-computed.** | +| experiments | optional | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | | +| logLevel | optional | 'silent' \| 'error' \| 'warn' | Tells Puppeteer to log at the given level. | warn | +| skipChromeDownload | optional | boolean |

Tells Puppeteer to not Chrome download during installation.

Can be overridden by PUPPETEER_SKIP_CHROME_DOWNLOAD.

| | +| skipChromeHeadlessShellDownload | optional | boolean |

Tells Puppeteer to not chrome-headless-shell download during installation.

Can be overridden by PUPPETEER_SKIP_CHROME_HEADLESSS_HELL_DOWNLOAD.

| | +| skipDownload | optional | boolean |

Tells Puppeteer to not download during installation.

Can be overridden by PUPPETEER_SKIP_DOWNLOAD.

| | +| temporaryDirectory | optional | string |

Defines the directory to be used by Puppeteer for creating temporary files.

Can be overridden by PUPPETEER_TMP_DIR.

| os.tmpdir() | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connect.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connect.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connect.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connect.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection._constructor_.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection._constructor_.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection._constructor_.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection._constructor_.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.createsession.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.createsession.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.createsession.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.createsession.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.dispose.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.dispose.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.dispose.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.dispose.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.fromsession.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.fromsession.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.fromsession.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.fromsession.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.connection.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.md new file mode 100644 index 00000000000..3b7d0560412 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.md @@ -0,0 +1,36 @@ +--- +sidebar_label: Connection +--- + +# Connection class + +#### Signature: + +```typescript +export declare class Connection extends EventEmitter +``` + +**Extends:** [EventEmitter](./puppeteer.eventemitter.md)<[CDPSessionEvents](./puppeteer.cdpsessionevents.md)> + +## Constructors + +| Constructor | Modifiers | Description | +| ---------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------- | +| [(constructor)(url, transport, delay, timeout)](./puppeteer.connection._constructor_.md) | | Constructs a new instance of the Connection class | + +## Properties + +| Property | Modifiers | Type | Description | +| -------- | --------------------- | ------ | ----------- | +| timeout | readonly | number | | + +## Methods + +| Method | Modifiers | Description | +| -------------------------------------------------------------------- | ------------------- | ----------- | +| [createSession(targetInfo)](./puppeteer.connection.createsession.md) | | | +| [dispose()](./puppeteer.connection.dispose.md) | | | +| [fromSession(session)](./puppeteer.connection.fromsession.md) | static | | +| [send(method, params, options)](./puppeteer.connection.send.md) | | | +| [session(sessionId)](./puppeteer.connection.session.md) | | | +| [url()](./puppeteer.connection.url.md) | | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.send.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.send.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.send.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.send.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.session.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.session.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.session.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.session.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connection.url.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connection.url.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connection.url.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connection.url.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.close.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.close.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.close.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.close.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.md similarity index 64% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.md index 73ab0dc4564..39c56a17601 100644 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.md +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.md @@ -19,7 +19,7 @@ export interface ConnectionTransport ## Methods -| Method | Description | -| ------------------------------------------------- | ----------- | -| [close](./puppeteer.connectiontransport.close.md) | | -| [send](./puppeteer.connectiontransport.send.md) | | +| Method | Description | +| -------------------------------------------------------- | ----------- | +| [close()](./puppeteer.connectiontransport.close.md) | | +| [send(message)](./puppeteer.connectiontransport.send.md) | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.send.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.send.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connectiontransport.send.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connectiontransport.send.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.connectoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.connectoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.connectoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.connectoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage._constructor_.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage._constructor_.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage._constructor_.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage._constructor_.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.args.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.args.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.args.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.args.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.location.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.location.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.location.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.location.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.md new file mode 100644 index 00000000000..812da548198 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.md @@ -0,0 +1,29 @@ +--- +sidebar_label: ConsoleMessage +--- + +# ConsoleMessage class + +ConsoleMessage objects are dispatched by page via the 'console' event. + +#### Signature: + +```typescript +export declare class ConsoleMessage +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------ | +| [(constructor)(type, text, args, stackTraceLocations)](./puppeteer.consolemessage._constructor_.md) | | Constructs a new instance of the ConsoleMessage class | + +## Methods + +| Method | Modifiers | Description | +| -------------------------------------------------------- | --------- | ----------------------------------------------------------- | +| [args()](./puppeteer.consolemessage.args.md) | | An array of arguments passed to the console. | +| [location()](./puppeteer.consolemessage.location.md) | | The location of the console message. | +| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) | | The array of locations on the stack of the console message. | +| [text()](./puppeteer.consolemessage.text.md) | | The text of the console message. | +| [type()](./puppeteer.consolemessage.type.md) | | The type of the console message. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.stacktrace.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.stacktrace.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.stacktrace.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.stacktrace.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.text.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.text.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.text.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.text.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.type.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.type.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessage.type.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessage.type.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessagelocation.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessagelocation.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessagelocation.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessagelocation.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.consolemessagetype.md b/website/versioned_docs/version-21.10.0/api/puppeteer.consolemessagetype.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.consolemessagetype.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.consolemessagetype.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.continuerequestoverrides.md b/website/versioned_docs/version-21.10.0/api/puppeteer.continuerequestoverrides.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.continuerequestoverrides.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.continuerequestoverrides.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverage._constructor_.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage._constructor_.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverage._constructor_.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverage._constructor_.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.md new file mode 100644 index 00000000000..7dd807a8865 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.md @@ -0,0 +1,59 @@ +--- +sidebar_label: Coverage +--- + +# Coverage class + +The Coverage class provides methods to gather information about parts of JavaScript and CSS that were used by the page. + +#### Signature: + +```typescript +export declare class Coverage +``` + +## Remarks + +To output coverage in a form consumable by [Istanbul](https://github.com/istanbuljs), see [puppeteer-to-istanbul](https://github.com/istanbuljs/puppeteer-to-istanbul). + +## Example + +An example of using JavaScript and CSS coverage to get percentage of initially executed code: + +```ts +// Enable both JavaScript and CSS coverage +await Promise.all([ + page.coverage.startJSCoverage(), + page.coverage.startCSSCoverage(), +]); +// Navigate to page +await page.goto('https://example.com'); +// Disable both JavaScript and CSS coverage +const [jsCoverage, cssCoverage] = await Promise.all([ + page.coverage.stopJSCoverage(), + page.coverage.stopCSSCoverage(), +]); +let totalBytes = 0; +let usedBytes = 0; +const coverage = [...jsCoverage, ...cssCoverage]; +for (const entry of coverage) { + totalBytes += entry.text.length; + for (const range of entry.ranges) usedBytes += range.end - range.start - 1; +} +console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`); +``` + +## Constructors + +| Constructor | Modifiers | Description | +| -------------------------------------------------------------- | --------- | ------------------------------------------------------------ | +| [(constructor)(client)](./puppeteer.coverage._constructor_.md) | | Constructs a new instance of the Coverage class | + +## Methods + +| Method | Modifiers | Description | +| --------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------- | +| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) | | | +| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md) | | | +| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md) | | Promise that resolves to the array of coverage reports for all stylesheets. | +| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md) | | Promise that resolves to the array of coverage reports for all scripts. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverage.startcsscoverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.startcsscoverage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverage.startcsscoverage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverage.startcsscoverage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverage.startjscoverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.startjscoverage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverage.startjscoverage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverage.startjscoverage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverage.stopcsscoverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.stopcsscoverage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverage.stopcsscoverage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverage.stopcsscoverage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverage.stopjscoverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverage.stopjscoverage.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverage.stopjscoverage.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverage.stopjscoverage.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.coverageentry.md b/website/versioned_docs/version-21.10.0/api/puppeteer.coverageentry.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.coverageentry.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.coverageentry.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.credentials.md b/website/versioned_docs/version-21.10.0/api/puppeteer.credentials.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.credentials.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.credentials.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage._constructor_.md b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage._constructor_.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage._constructor_.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage._constructor_.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.md b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.md new file mode 100644 index 00000000000..a75a886a975 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.md @@ -0,0 +1,24 @@ +--- +sidebar_label: CSSCoverage +--- + +# CSSCoverage class + +#### Signature: + +```typescript +export declare class CSSCoverage +``` + +## Constructors + +| Constructor | Modifiers | Description | +| ----------------------------------------------------------------- | --------- | --------------------------------------------------------------- | +| [(constructor)(client)](./puppeteer.csscoverage._constructor_.md) | | Constructs a new instance of the CSSCoverage class | + +## Methods + +| Method | Modifiers | Description | +| -------------------------------------------------- | --------- | ----------- | +| [start(options)](./puppeteer.csscoverage.start.md) | | | +| [stop()](./puppeteer.csscoverage.stop.md) | | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage.start.md b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.start.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage.start.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.start.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage.stop.md b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.stop.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.csscoverage.stop.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.csscoverage.stop.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.csscoverageoptions.md b/website/versioned_docs/version-21.10.0/api/puppeteer.csscoverageoptions.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.csscoverageoptions.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.csscoverageoptions.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.customerror.md b/website/versioned_docs/version-21.10.0/api/puppeteer.customerror.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.customerror.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.customerror.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.customqueryhandler.md b/website/versioned_docs/version-21.10.0/api/puppeteer.customqueryhandler.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.customqueryhandler.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.customqueryhandler.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.customqueryhandlernames.md b/website/versioned_docs/version-21.10.0/api/puppeteer.customqueryhandlernames.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.customqueryhandlernames.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.customqueryhandlernames.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.debuginfo.md b/website/versioned_docs/version-21.10.0/api/puppeteer.debuginfo.md new file mode 100644 index 00000000000..f20ed755451 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.debuginfo.md @@ -0,0 +1,17 @@ +--- +sidebar_label: DebugInfo +--- + +# DebugInfo interface + +#### Signature: + +```typescript +export interface DebugInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | Default | +| --------------------- | --------- | --------- | ----------- | ------- | +| pendingProtocolErrors | | Error\[\] | | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.default_intercept_resolution_priority.md b/website/versioned_docs/version-21.10.0/api/puppeteer.default_intercept_resolution_priority.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.default_intercept_resolution_priority.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.default_intercept_resolution_priority.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.defaultargs.md b/website/versioned_docs/version-21.10.0/api/puppeteer.defaultargs.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.defaultargs.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.defaultargs.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.device.md b/website/versioned_docs/version-21.10.0/api/puppeteer.device.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.device.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.device.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.cancel.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.cancel.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.cancel.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.cancel.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.md similarity index 67% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.md index 4c1e98a8c92..ee9f1a62fc3 100644 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.md +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.md @@ -38,8 +38,8 @@ await devicePrompt.select( ## Methods -| Method | Modifiers | Description | -| ----------------------------------------------------------------- | --------- | ------------------------------------------------------------ | -| [cancel](./puppeteer.devicerequestprompt.cancel.md) | | Cancel the prompt. | -| [select](./puppeteer.devicerequestprompt.select.md) | | Select a device in the prompt's list. | -| [waitForDevice](./puppeteer.devicerequestprompt.waitfordevice.md) | | Resolve to the first device in the prompt matching a filter. | +| Method | Modifiers | Description | +| ---------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ | +| [cancel()](./puppeteer.devicerequestprompt.cancel.md) | | Cancel the prompt. | +| [select(device)](./puppeteer.devicerequestprompt.select.md) | | Select a device in the prompt's list. | +| [waitForDevice(filter, options)](./puppeteer.devicerequestprompt.waitfordevice.md) | | Resolve to the first device in the prompt matching a filter. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.select.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.select.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.select.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.select.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.waitfordevice.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.waitfordevice.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestprompt.waitfordevice.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestprompt.waitfordevice.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestpromptdevice.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestpromptdevice.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devicerequestpromptdevice.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devicerequestpromptdevice.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.devices.md b/website/versioned_docs/version-21.10.0/api/puppeteer.devices.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.devices.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.devices.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.dialog.accept.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.accept.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.dialog.accept.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.dialog.accept.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.dialog.defaultvalue.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.defaultvalue.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.dialog.defaultvalue.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.dialog.defaultvalue.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.dialog.dismiss.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.dismiss.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.dialog.dismiss.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.dialog.dismiss.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.md new file mode 100644 index 00000000000..26423c45f37 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.md @@ -0,0 +1,44 @@ +--- +sidebar_label: Dialog +--- + +# Dialog class + +Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the `dialog` event. + +#### Signature: + +```typescript +export declare abstract class Dialog +``` + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Dialog` class. + +## Example + +```ts +import puppeteer from 'puppeteer'; + +(async () => { + const browser = await puppeteer.launch(); + const page = await browser.newPage(); + page.on('dialog', async dialog => { + console.log(dialog.message()); + await dialog.dismiss(); + await browser.close(); + }); + page.evaluate(() => alert('1')); +})(); +``` + +## Methods + +| Method | Modifiers | Description | +| ---------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------- | +| [accept(promptText)](./puppeteer.dialog.accept.md) | | A promise that resolves when the dialog has been accepted. | +| [defaultValue()](./puppeteer.dialog.defaultvalue.md) | | The default value of the prompt, or an empty string if the dialog is not a prompt. | +| [dismiss()](./puppeteer.dialog.dismiss.md) | | A promise which will resolve once the dialog has been dismissed | +| [message()](./puppeteer.dialog.message.md) | | The message displayed in the dialog. | +| [type()](./puppeteer.dialog.type.md) | | The type of the dialog. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.dialog.message.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.message.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.dialog.message.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.dialog.message.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.dialog.type.md b/website/versioned_docs/version-21.10.0/api/puppeteer.dialog.type.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.dialog.type.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.dialog.type.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementfor.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementfor.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementfor.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementfor.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.__.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.__.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.__.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.__.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.__eval.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.__eval.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.__eval.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.__eval.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._eval.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._eval.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._eval.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._eval.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._x.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._x.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle._x.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle._x.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.autofill.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.autofill.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.autofill.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.autofill.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.boundingbox.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.boundingbox.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.boundingbox.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.boundingbox.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.boxmodel.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.boxmodel.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.boxmodel.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.boxmodel.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.click.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.click.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.click.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.click.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.clickablepoint.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.clickablepoint.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.clickablepoint.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.clickablepoint.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.contentframe.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.contentframe.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.contentframe.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.contentframe.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.contentframe_1.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.contentframe_1.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.contentframe_1.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.contentframe_1.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drag.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drag.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drag.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drag.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.draganddrop.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.draganddrop.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.draganddrop.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.draganddrop.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.dragenter.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.dragenter.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.dragenter.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.dragenter.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.dragover.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.dragover.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.dragover.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.dragover.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drop.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drop.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drop.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drop.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drop_1.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drop_1.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.drop_1.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.drop_1.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.focus.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.focus.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.focus.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.focus.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.hover.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.hover.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.hover.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.hover.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.ishidden.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.ishidden.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.ishidden.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.ishidden.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.isintersectingviewport.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.isintersectingviewport.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.isintersectingviewport.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.isintersectingviewport.md diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.isvisible.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.isvisible.md similarity index 100% rename from website/versioned_docs/version-21.9.0/api/puppeteer.elementhandle.isvisible.md rename to website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.isvisible.md diff --git a/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.md b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.md new file mode 100644 index 00000000000..b47b5abf450 --- /dev/null +++ b/website/versioned_docs/version-21.10.0/api/puppeteer.elementhandle.md @@ -0,0 +1,88 @@ +--- +sidebar_label: ElementHandle +--- + +# ElementHandle class + +ElementHandle represents an in-page DOM element. + +#### Signature: + +```typescript +export declare abstract class ElementHandle extends JSHandle +``` + +**Extends:** [JSHandle](./puppeteer.jshandle.md)<ElementType> + +## Remarks + +ElementHandles can be created with the [Page.$()](./puppeteer.page._.md) method. + +```ts +import puppeteer from 'puppeteer'; + +(async () => { + const browser = await puppeteer.launch(); + const page = await browser.newPage(); + await page.goto('https://example.com'); + const hrefElement = await page.$('a'); + await hrefElement.click(); + // ... +})(); +``` + +ElementHandle prevents the DOM element from being garbage-collected unless the handle is [disposed](./puppeteer.jshandle.dispose.md). ElementHandles are auto-disposed when their origin frame gets navigated. + +ElementHandle instances can be used as arguments in [Page.$eval()](./puppeteer.page._eval.md) and [Page.evaluate()](./puppeteer.page.evaluate.md) methods. + +If you're using TypeScript, ElementHandle takes a generic argument that denotes the type of element the handle is holding within. For example, if you have a handle to a `` element, you can type it as `ElementHandle` and you get some nicer type checks. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ElementHandle` class. - -## Properties - -| Property | Modifiers | Type | Description | -| -------- | --------------------- | ----------------------------- | ------------------------------------------ | -| frame | readonly | [Frame](./puppeteer.frame.md) | Frame corresponding to the current handle. | - -## Methods - -| Method | Modifiers | Description | -| ----------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [$](./puppeteer.elementhandle._.md) | | Queries the current element for an element matching the given selector. | -| [$$](./puppeteer.elementhandle.__.md) | | Queries the current element for all elements matching the given selector. | -| [$$eval](./puppeteer.elementhandle.__eval.md) | |

Runs the given function on an array of elements matching the given selector in the current element.

If the given function returns a promise, then this method will wait till the promise resolves.

| -| [$eval](./puppeteer.elementhandle._eval.md) | |

Runs the given function on the first element matching the given selector in the current element.

If the given function returns a promise, then this method will wait till the promise resolves.

| -| [$x](./puppeteer.elementhandle._x.md) | | | -| [autofill](./puppeteer.elementhandle.autofill.md) | | If the element is a form input, you can use [ElementHandle.autofill()](./puppeteer.elementhandle.autofill.md) to test if the form is compatible with the browser's autofill implementation. Throws an error if the form cannot be autofilled. | -| [boundingBox](./puppeteer.elementhandle.boundingbox.md) | | This method returns the bounding box of the element (relative to the main frame), or null if the element is [not part of the layout](https://drafts.csswg.org/css-display-4/#box-generation) (example: display: none). | -| [boxModel](./puppeteer.elementhandle.boxmodel.md) | | This method returns boxes of the element, or null if the element is [not part of the layout](https://drafts.csswg.org/css-display-4/#box-generation) (example: display: none). | -| [click](./puppeteer.elementhandle.click.md) | | This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.md) to click in the center of the element. If the element is detached from DOM, the method throws an error. | -| [clickablePoint](./puppeteer.elementhandle.clickablepoint.md) | | Returns the middle point within an element unless a specific offset is provided. | -| [contentFrame](./puppeteer.elementhandle.contentframe.md) | | Resolves the frame associated with the element, if any. Always exists for HTMLIFrameElements. | -| [contentFrame](./puppeteer.elementhandle.contentframe_1.md) | | | -| [drag](./puppeteer.elementhandle.drag.md) | | Drags an element over the given element or point. | -| [dragAndDrop](./puppeteer.elementhandle.draganddrop.md) | | | -| [dragEnter](./puppeteer.elementhandle.dragenter.md) | | | -| [dragOver](./puppeteer.elementhandle.dragover.md) | | | -| [drop](./puppeteer.elementhandle.drop.md) | | Drops the given element onto the current one. | -| [drop](./puppeteer.elementhandle.drop_1.md) | | | -| [focus](./puppeteer.elementhandle.focus.md) | | Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. | -| [hover](./puppeteer.elementhandle.hover.md) | | This method scrolls element into view if needed, and then uses [Page](./puppeteer.page.md) to hover over the center of the element. If the element is detached from DOM, the method throws an error. | -| [isHidden](./puppeteer.elementhandle.ishidden.md) | | Checks if an element is hidden using the same mechanism as [ElementHandle.waitForSelector()](./puppeteer.elementhandle.waitforselector.md). | -| [isIntersectingViewport](./puppeteer.elementhandle.isintersectingviewport.md) | | Resolves to true if the element is visible in the current viewport. If an element is an SVG, we check if the svg owner element is in the viewport instead. See https://crbug.com/963246. | -| [isVisible](./puppeteer.elementhandle.isvisible.md) | | Checks if an element is visible using the same mechanism as [ElementHandle.waitForSelector()](./puppeteer.elementhandle.waitforselector.md). | -| [press](./puppeteer.elementhandle.press.md) | | Focuses the element, and then uses [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md). | -| [screenshot](./puppeteer.elementhandle.screenshot.md) | | This method scrolls element into view if needed, and then uses [Page.screenshot()](./puppeteer.page.screenshot_1.md) to take a screenshot of the element. If the element is detached from DOM, the method throws an error. | -| [screenshot](./puppeteer.elementhandle.screenshot_1.md) | | | -| [scrollIntoView](./puppeteer.elementhandle.scrollintoview.md) | | Scrolls the element into view using either the automation protocol client or by calling element.scrollIntoView. | -| [select](./puppeteer.elementhandle.select.md) | | Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error. | -| [tap](./puppeteer.elementhandle.tap.md) | | This method scrolls element into view if needed, and then uses [Touchscreen.tap()](./puppeteer.touchscreen.tap.md) to tap in the center of the element. If the element is detached from DOM, the method throws an error. | -| [toElement](./puppeteer.elementhandle.toelement.md) | | Converts the current handle to the given element type. | -| [touchEnd](./puppeteer.elementhandle.touchend.md) | | | -| [touchMove](./puppeteer.elementhandle.touchmove.md) | | | -| [touchStart](./puppeteer.elementhandle.touchstart.md) | | | -| [type](./puppeteer.elementhandle.type.md) | |

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use [ElementHandle.press()](./puppeteer.elementhandle.press.md).

| -| [uploadFile](./puppeteer.elementhandle.uploadfile.md) | | Sets the value of an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) to the given file paths. | -| [waitForSelector](./puppeteer.elementhandle.waitforselector.md) | |

Wait for an element matching the given selector to appear in the current element.

Unlike [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md), this method does not work across navigations or if the element is detached from DOM.

| -| [waitForXPath](./puppeteer.elementhandle.waitforxpath.md) | | | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.eventemitter.md b/website/versioned_docs/version-21.9.0/api/puppeteer.eventemitter.md deleted file mode 100644 index 84932617c05..00000000000 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.eventemitter.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_label: EventEmitter ---- - -# EventEmitter class - -The EventEmitter class that many Puppeteer classes extend. - -#### Signature: - -```typescript -export declare class EventEmitter> implements CommonEventEmitter> -``` - -**Implements:** [CommonEventEmitter](./puppeteer.commoneventemitter.md)<[EventsWithWildcard](./puppeteer.eventswithwildcard.md)<Events>> - -## Remarks - -This allows you to listen to events that Puppeteer classes fire and act accordingly. Therefore you'll mostly use [on](./puppeteer.eventemitter.on.md) and [off](./puppeteer.eventemitter.off.md) to bind and unbind to event listeners. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `EventEmitter` class. - -## Methods - -| Method | Modifiers | Description | -| -------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------ | -| [addListener](./puppeteer.eventemitter.addlistener.md) | | Add an event listener. | -| [emit](./puppeteer.eventemitter.emit.md) | | Emit an event and call any associated listeners. | -| [listenerCount](./puppeteer.eventemitter.listenercount.md) | | Gets the number of listeners for a given event. | -| [off](./puppeteer.eventemitter.off.md) | | Remove an event listener from firing. | -| [on](./puppeteer.eventemitter.on.md) | | Bind an event listener to fire when an event occurs. | -| [once](./puppeteer.eventemitter.once.md) | | Like on but the listener will only be fired once and then it will be removed. | -| [removeAllListeners](./puppeteer.eventemitter.removealllisteners.md) | | Removes all listeners. If given an event argument, it will remove only listeners for that event. | -| [removeListener](./puppeteer.eventemitter.removelistener.md) | | Remove an event listener. | diff --git a/website/versioned_docs/version-21.9.0/api/puppeteer.frame.md b/website/versioned_docs/version-21.9.0/api/puppeteer.frame.md deleted file mode 100644 index 0c941f3d4b7..00000000000 --- a/website/versioned_docs/version-21.9.0/api/puppeteer.frame.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -sidebar_label: Frame ---- - -# Frame class - -Represents a DOM frame. - -To understand frames, you can think of frames as `