From 97b485bd742c5e3391b7c667ba937ffe39c2d2e3 Mon Sep 17 00:00:00 2001 From: Max Schmitt Date: Thu, 22 Apr 2021 19:13:19 +0200 Subject: [PATCH] docs(python): add BrowserType.connectOverCDP (#6270) --- docs/src/api/class-browsertype.md | 22 +++++++++++++++++++++- docs/src/api/java.md | 20 -------------------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md index 9ec4e25bc1..a848477350 100644 --- a/docs/src/api/class-browsertype.md +++ b/docs/src/api/class-browsertype.md @@ -102,7 +102,7 @@ Maximum time in milliseconds to wait for the connection to be established. Defau `30000` (30 seconds). Pass `0` to disable timeout. ## async method: BrowserType.connectOverCDP -* langs: java, js +* langs: java, js, python - returns: <[Browser]> This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol. @@ -123,6 +123,26 @@ Connecting over the Chrome DevTools Protocol is only supported for Chromium-base - `timeout` <[float]> Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. +### param: BrowserType.connectOverCDP.endpointURL +* langs: java, python +- `endpointURL` <[string]> + +A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`. + +### option: BrowserType.connectOverCDP.slowMo +* langs: java, python +- `slowMo` <[float]> + +Slows down Playwright operations by the specified amount of milliseconds. Useful so that you +can see what is going on. Defaults to 0. + +### option: BrowserType.connectOverCDP.timeout +* langs: java, python +- `timeout` <[float]> + +Maximum time in milliseconds to wait for the connection to be established. Defaults to +`30000` (30 seconds). Pass `0` to disable timeout. + ## method: BrowserType.executablePath - returns: <[string]> diff --git a/docs/src/api/java.md b/docs/src/api/java.md index 8e51cd99c5..fba3bccf85 100644 --- a/docs/src/api/java.md +++ b/docs/src/api/java.md @@ -58,12 +58,6 @@ page.navigate("https://www.w3.org/"); playwright.close(); ``` -### param: BrowserType.connectOverCDP.endpointURL -* langs: java -- `endpointURL` <[string]> - -A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`. - ### param: BrowserContext.waitForPage.callback = %%-java-wait-for-event-callback-%% ### param: Frame.waitForNavigation.callback = %%-java-wait-for-event-callback-%% @@ -94,20 +88,6 @@ A CDP websocket endpoint or http url to connect to. For example `http://localhos ### param: Worker.waitForClose.callback = %%-java-wait-for-event-callback-%% -### option: BrowserType.connectOverCDP.slowMo -* langs: java -- `slowMo` <[float]> - -Slows down Playwright operations by the specified amount of milliseconds. Useful so that you -can see what is going on. Defaults to 0. - -### option: BrowserType.connectOverCDP.timeout -* langs: java -- `timeout` <[float]> - -Maximum time in milliseconds to wait for the connection to be established. Defaults to -`30000` (30 seconds). Pass `0` to disable timeout. - ### option: BrowserType.launch.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%% ### option: BrowserType.launchPersistentContext.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%% ### option: BrowserType.launch.ignoreAllDefaultArgs = %%-csharp-java-browser-option-ignorealldefaultargs-%%