Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Revert "Revert "chore(docs): clarify connection method via BrowserType.connect (#34560)" (#34594)" (#34595)

Browse source
This commit is contained in:
Adam Gastineau 2025-02-03 06:21:00 -08:00 committed by GitHub
parent 340834195b
commit 5996a0df0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 32 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/src/api/class-browsertype.md
View file

@ -89,13 +89,17 @@ class BrowserTypeExamples
* since: v1.8 * since: v1.8
- returns: <[Browser]> - returns: <[Browser]>
This method attaches Playwright to an existing browser instance. When connecting to another browser launched via `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x). This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
:::note
The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
:::
### param: BrowserType.connect.wsEndpoint ### param: BrowserType.connect.wsEndpoint
* since: v1.10 * since: v1.10
- `wsEndpoint` <[string]> - `wsEndpoint` <[string]>
A browser websocket endpoint to connect to. A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
### option: BrowserType.connect.headers ### option: BrowserType.connect.headers
* since: v1.11 * since: v1.11
@ -152,6 +156,10 @@ The default browser context is accessible via [`method: Browser.contexts`].
Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers. Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
::: :::
:::note
This connection is significantly lower fidelity than the Playwright protocol connection via [`method: BrowserType.connect`]. If you are experiencing issues or attempting to use advanced functionality, you probably want to use [`method: BrowserType.connect`].
:::
**Usage** **Usage**
```js ```js

30
packages/playwright-core/types/types.d.ts vendored
View file

@ -14554,6 +14554,11 @@ export interface BrowserType<Unused = {}> {
* *
* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers. * **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
* *
* **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
* [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
* If you are experiencing issues or attempting to use advanced functionality, you probably want to use
* [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
*
* **Usage** * **Usage**
* *
* ```js * ```js
@ -14579,6 +14584,11 @@ export interface BrowserType<Unused = {}> {
* *
* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers. * **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
* *
* **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
* [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
* If you are experiencing issues or attempting to use advanced functionality, you probably want to use
* [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
*
* **Usage** * **Usage**
* *
* ```js * ```js
@ -14593,10 +14603,12 @@ export interface BrowserType<Unused = {}> {
*/ */
connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise<Browser>; connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise<Browser>;
/** /**
* This method attaches Playwright to an existing browser instance. When connecting to another browser launched via * This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
* `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is *
* compatible with 1.2.x). * **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
* @param wsEndpoint A browser websocket endpoint to connect to. * Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
*
* @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
* @param options * @param options
*/ */
connect(wsEndpoint: string, options?: ConnectOptions): Promise<Browser>; connect(wsEndpoint: string, options?: ConnectOptions): Promise<Browser>;
@ -14607,10 +14619,12 @@ export interface BrowserType<Unused = {}> {
* @deprecated * @deprecated
*/ */
/** /**
* This method attaches Playwright to an existing browser instance. When connecting to another browser launched via * This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
* `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is *
* compatible with 1.2.x). * **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
* @param wsEndpoint A browser websocket endpoint to connect to. * Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
*
* @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
* @param options * @param options
*/ */
connect(options: ConnectOptions & { wsEndpoint?: string }): Promise<Browser>; connect(options: ConnectOptions & { wsEndpoint?: string }): Promise<Browser>;