From 7910849607156556a972cb58602307755d1df431 Mon Sep 17 00:00:00 2001 From: Adam Gastineau Date: Thu, 30 Jan 2025 11:56:56 -0800 Subject: [PATCH] PR comments --- docs/src/api/class-browsertype.md | 14 +++++++++++--- packages/playwright-core/types/types.d.ts | 22 ++++++++++++---------- 2 files changed, 23 insertions(+), 13 deletions(-) diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md index 04131d28eb..87a684db3d 100644 --- a/docs/src/api/class-browsertype.md +++ b/docs/src/api/class-browsertype.md @@ -90,20 +90,28 @@ class BrowserTypeExamples * langs: js - returns: <[Browser]> -This method attaches Playwright to an existing browser instance created via [`method: BrowserType.launchServer`], which can only be run from Node.js. When connecting to another browser, the major and minor version of the Playwright instance you're calling from needs to match the client browser version (1.2.3 → is compatible with 1.2.x). +This method attaches Playwright to an existing browser instance created via [`method: BrowserType.launchServer`]. + +:::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). +::: ## async method: BrowserType.connect * since: v1.8 * langs: python, csharp, java - returns: <[Browser]> -This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js. When connecting to another browser, the major and minor version of the Playwright instance you're calling from needs to match the client browser 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 * since: v1.10 - `wsEndpoint` <[string]> -A Playwright browser websocket endpoint to connect to. You obtain this endpoint via [`method: BrowserServer.wsEndpoint`] +A Playwright browser websocket endpoint to connect to. You obtain this endpoint via [`method: BrowserServer.wsEndpoint`]. ### option: BrowserType.connect.headers * since: v1.11 diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index 4a3133105b..67efa84ec6 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -14604,12 +14604,13 @@ export interface BrowserType { connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise; /** * This method attaches Playwright to an existing browser instance created via - * [browserType.launchServer([options])](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server), - * which can only be run from Node.js. When connecting to another browser, the major and minor version of the - * Playwright instance you're calling from needs to match the client browser version (1.2.3 → is compatible with - * 1.2.x). + * [browserType.launchServer([options])](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server). + * + * **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 wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via - * [browserServer.wsEndpoint()](https://playwright.dev/docs/api/class-browserserver#browser-server-ws-endpoint) + * [browserServer.wsEndpoint()](https://playwright.dev/docs/api/class-browserserver#browser-server-ws-endpoint). * @param options */ connect(wsEndpoint: string, options?: ConnectOptions): Promise; @@ -14621,12 +14622,13 @@ export interface BrowserType { */ /** * This method attaches Playwright to an existing browser instance created via - * [browserType.launchServer([options])](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server), - * which can only be run from Node.js. When connecting to another browser, the major and minor version of the - * Playwright instance you're calling from needs to match the client browser version (1.2.3 → is compatible with - * 1.2.x). + * [browserType.launchServer([options])](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server). + * + * **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 wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via - * [browserServer.wsEndpoint()](https://playwright.dev/docs/api/class-browserserver#browser-server-ws-endpoint) + * [browserServer.wsEndpoint()](https://playwright.dev/docs/api/class-browserserver#browser-server-ws-endpoint). * @param options */ connect(options: ConnectOptions & { wsEndpoint?: string }): Promise;