From cb9ac24c8b935d81b13694750a0fa8503a23f7d1 Mon Sep 17 00:00:00 2001 From: Adam Gastineau Date: Thu, 30 Jan 2025 11:11:19 -0800 Subject: [PATCH] Update forgotten types --- packages/playwright-core/types/types.d.ts | 32 +++++++++++++++++------ 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index a841123461..4a3133105b 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -14554,6 +14554,11 @@ export interface BrowserType { * * **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** * * ```js @@ -14579,6 +14584,11 @@ export interface BrowserType { * * **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** * * ```js @@ -14593,10 +14603,13 @@ export interface BrowserType { */ connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise; /** - * 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). - * @param wsEndpoint A browser websocket endpoint to connect to. + * 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). + * @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) * @param options */ connect(wsEndpoint: string, options?: ConnectOptions): Promise; @@ -14607,10 +14620,13 @@ export interface BrowserType { * @deprecated */ /** - * 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). - * @param wsEndpoint A browser websocket endpoint to connect to. + * 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). + * @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) * @param options */ connect(options: ConnectOptions & { wsEndpoint?: string }): Promise;